From bd3c7ab6ca9767b805a311c1f5e6be418d77f2f5 Mon Sep 17 00:00:00 2001 From: Daniel Jaglowski Date: Wed, 23 Nov 2022 14:37:04 -0500 Subject: [PATCH] [receiver/snmp] Set component status to alpha (#16454) --- .chloggen/snmp-alpha.yaml | 16 ++++++++++++++++ receiver/snmpreceiver/README.md | 16 ++++++++-------- receiver/snmpreceiver/factory.go | 2 +- 3 files changed, 25 insertions(+), 9 deletions(-) create mode 100755 .chloggen/snmp-alpha.yaml diff --git a/.chloggen/snmp-alpha.yaml b/.chloggen/snmp-alpha.yaml new file mode 100755 index 000000000000..fa11acd3b0cf --- /dev/null +++ b/.chloggen/snmp-alpha.yaml @@ -0,0 +1,16 @@ +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: enhancement + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: snmpreceiver + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Set component status to alpha + +# One or more tracking issues related to the change +issues: [16454] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: diff --git a/receiver/snmpreceiver/README.md b/receiver/snmpreceiver/README.md index 9c906d9b0365..58b080bddeba 100644 --- a/receiver/snmpreceiver/README.md +++ b/receiver/snmpreceiver/README.md @@ -2,7 +2,7 @@ | Status | | | ------------------------ |---------------| -| Stability | [development] | +| Stability | [alpha] | | Supported pipeline types | metrics | | Distributions | [contrib] | @@ -71,7 +71,7 @@ These configuration options are for determining what metrics and attributes will #### Resource Attribute Configuration Resource attribute configurations are used to define what resource attributes will be used in a collection. -| Field Name | Description | Value | +| Field Name | Description | Value | | -- | -- | -- | | `oid` | Required if no `indexed_value_prefix`. This is the column OID in a SNMP table which will use the returned indexed SNMP data to create resource attribute values for unique resources. Metric configurations will reference these resource attribute configurations in order to assign metrics data to resources | string | | `indexed_value_prefix` | Required if no `oid`. This is a string prefix which will be added to the indices of returned metric indexed SNMP data to create resource attribute values for unique resources. Metric configurations will reference these resource attribute configurations in order to assign metrics data to resources | string | @@ -148,13 +148,13 @@ receivers: auth_password: $SNMP_AUTH_PASSWORD privacy_type: "DES" privacy_password: $SNMP_PRIVACY_PASSWORD - + resource_attributes: resource_attr.name.1: indexed_value_prefix: probe resource_attr.name.2: oid: "1.1.1.1" - + attributes: attr.name.1: value: a2_new_key @@ -165,7 +165,7 @@ receivers: indexed_value_prefix: device attr.name.3: oid: "2.2.2.2" - + metrics: # This metric will have multiple datapoints wil 1 attribute on each. # Each datapoint will have a (hopefully) different attribute value @@ -208,11 +208,11 @@ receivers: monotonic: false value_type: double scalar_oids: - - oid: "4.4.4.4.0" + - oid: "4.4.4.4.0" attributes: - name: attr.name.1 value: in - - oid: "4.4.4.5.0" + - oid: "4.4.4.5.0" attributes: - name: aattr.name.1 value: out @@ -241,5 +241,5 @@ receivers: The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). -[development]: https://github.com/open-telemetry/opentelemetry-collector#development +[alpha]: https://github.com/open-telemetry/opentelemetry-collector#development [contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib diff --git a/receiver/snmpreceiver/factory.go b/receiver/snmpreceiver/factory.go index 38c5c45a2ddf..b613da3dcc5f 100644 --- a/receiver/snmpreceiver/factory.go +++ b/receiver/snmpreceiver/factory.go @@ -29,7 +29,7 @@ import ( const ( typeStr = "snmp" - stability = component.StabilityLevelDevelopment + stability = component.StabilityLevelAlpha ) var errConfigNotSNMP = errors.New("config was not a SNMP receiver config")