Skip to content

Commit

Permalink
[chore][sshcheck] added metadata stability (open-telemetry#21545)
Browse files Browse the repository at this point in the history
  • Loading branch information
BominRahmani authored May 9, 2023
1 parent b34331d commit 65e59bb
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 10 deletions.
16 changes: 9 additions & 7 deletions receiver/sshcheckreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# SSH Check Receiver

| Status | |
| ------------------------ |-----------|
| Stability | [in development] |
| Supported pipeline types | metrics |
| Distributions | [contrib] |
<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [development]: metrics |
| Distributions | [contrib] |

[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

This receiver creates stats by connecting to an SSH server which may be an SFTP server.

Expand Down Expand Up @@ -44,5 +48,3 @@ The full list of settings exposed for this receiver are documented [here](./conf
Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml)
[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
5 changes: 2 additions & 3 deletions receiver/sshcheckreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,15 @@ import (
)

const (
typeStr = "sshcheck"
stability = component.StabilityLevelDevelopment
typeStr = "sshcheck"
)

// NewFactory creates a new receiver factory
func NewFactory() receiver.Factory {
return receiver.NewFactory(
typeStr,
createDefaultConfig,
receiver.WithMetrics(createMetricsReceiver, stability))
receiver.WithMetrics(createMetricsReceiver, metadata.MetricsStability))
}

func createDefaultConfig() component.Config {
Expand Down
12 changes: 12 additions & 0 deletions receiver/sshcheckreceiver/internal/metadata/generated_status.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions receiver/sshcheckreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
type: sshcheckreceiver

status:
class: receiver
stability:
development: [metrics]
distributions: [contrib]

resource_attributes:
ssh.endpoint:
description: Full SSH endpoint
Expand Down

0 comments on commit 65e59bb

Please sign in to comment.