Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[receiver/snmp] Set component status to alpha #16454

Merged
merged 1 commit into from
Nov 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .chloggen/snmp-alpha.yaml
Original file line number Diff line number Diff line change
@@ -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:
16 changes: 8 additions & 8 deletions receiver/snmpreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

| Status | |
| ------------------------ |---------------|
| Stability | [development] |
| Stability | [alpha] |
| Supported pipeline types | metrics |
| Distributions | [contrib] |

Expand Down Expand Up @@ -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 |
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
2 changes: 1 addition & 1 deletion receiver/snmpreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down