Skip to content

Commit b18b8a9

Browse files
crobert-1pjanotti
andauthored
[receiver/lightprometheus] Deprecate receiver (#6949)
* [receiver/lightprometheus] Deprecate receiver * fix changelog - add issue --------- Co-authored-by: Paulo Janotti <[email protected]>
1 parent 10fc197 commit b18b8a9

File tree

3 files changed

+27
-9
lines changed

3 files changed

+27
-9
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
2+
change_type: deprecation
3+
4+
# The name of the component, or a single word describing the area of concern, (e.g. crosslink)
5+
component: receiver/lightprometheus
6+
7+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
8+
note: The `lightprometheus` receiver has been deprecated and will be removed in a future release.
9+
10+
# One or more tracking issues related to the change
11+
issues: [6949]
12+
13+
# (Optional) One or more lines of additional information to render under the primary note.
14+
# These lines will be padded with 2 spaces and then inserted directly into the document.
15+
# Use pipe (|) for multiline entries.
16+
subtext: |
17+
Please use the [Prometheus](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/prometheusreceiver) or
18+
[Simple Prometheus](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/simpleprometheusreceiver) receiver instead.

internal/receiver/lightprometheusreceiver/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Light Prometheus Receiver
22

3-
| Status | |
4-
| ------------------------ |---------------|
5-
| Stability | [development] |
6-
| Supported pipeline types | metrics |
7-
| Distributions | splunk |
3+
| Status | |
4+
| ------------------------ |--------------|
5+
| Stability | [deprecated] |
6+
| Supported pipeline types | metrics |
7+
| Distributions | splunk |
88

9-
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
9+
[deprecated]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#deprecated
10+
11+
:warning: Please use the [Prometheus](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/prometheusreceiver) or [Simple Prometheus](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/simpleprometheusreceiver) receiver instead.
1012

1113
## Overview
1214

@@ -15,8 +17,6 @@ convert them to OTLP metrics. It is intended to be used as a replacement for the
1517
Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/simpleprometheusreceiver)
1618
as it is more efficient and has a smaller memory footprint.
1719

18-
The receiver is under active development which means that configuration interface can change.
19-
2020
## Configuration
2121

2222
The following settings are required:

internal/receiver/lightprometheusreceiver/factory.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func NewFactory() receiver.Factory {
3030
return receiver.NewFactory(
3131
component.MustNewType(typeStr),
3232
createDefaultConfig,
33-
receiver.WithMetrics(createMetricsReceiver, component.StabilityLevelDevelopment),
33+
receiver.WithMetrics(createMetricsReceiver, component.StabilityLevelDeprecated),
3434
)
3535
}
3636

0 commit comments

Comments
 (0)