Skip to content

Commit 15cea9c

Browse files
reyangCodeBlanch
andauthored
[doc] update package level warning messages (#5608)
Co-authored-by: Mikel Blanchard <[email protected]>
1 parent c7abbdb commit 15cea9c

File tree

4 files changed

+25
-10
lines changed
  • src
    • OpenTelemetry.Exporter.Console
    • OpenTelemetry.Exporter.InMemory
    • OpenTelemetry.Exporter.Prometheus.AspNetCore
    • OpenTelemetry.Exporter.Prometheus.HttpListener

4 files changed

+25
-10
lines changed

src/OpenTelemetry.Exporter.Console/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ The console exporter prints data to the Console window.
77
ConsoleExporter supports exporting logs, metrics and traces.
88

99
> [!WARNING]
10-
> This exporter is intended to be used during learning how telemetry
11-
data are created and exported. It is not recommended for any production
12-
environment.
10+
> This component is intended to be used while learning how telemetry data is
11+
created and exported. It is not recommended for any production environment.
1312

1413
## Installation
1514

src/OpenTelemetry.Exporter.InMemory/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
The in-memory exporter stores data in a user provided memory buffer.
77

8+
> [!WARNING]
9+
> This component is intended to be used for testing purposes. It is
10+
not recommended for any production environment.
11+
812
## Installation
913

1014
```shell

src/OpenTelemetry.Exporter.Prometheus.AspNetCore/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,19 @@ An [OpenTelemetry Prometheus exporter](https://github.com/open-telemetry/opentel
77
for configuring an ASP.NET Core application with an endpoint for Prometheus
88
to scrape.
99

10+
> [!WARNING]
11+
> This component is still under development due to a dependency on the
12+
experimental [Prometheus and OpenMetrics
13+
Compatibility](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/compatibility/prometheus_and_openmetrics.md)
14+
specification and can undergo breaking changes before stable release.
15+
Production environments should consider using
16+
[OpenTelemetry.Exporter.OpenTelemetryProtocol](../OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md).
17+
Refer to the [Getting Started with Prometheus and
18+
Grafana](../../docs/metrics/getting-started-prometheus-grafana/README.md)
19+
tutorial for more information.
20+
21+
<!-- This comment is to make sure the two notes above and below are not merged -->
22+
1023
> [!NOTE]
1124
> This exporter does not support Exemplars. For using Exemplars, use the [OTLP
1225
Exporter](../OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md) and use a

src/OpenTelemetry.Exporter.Prometheus.HttpListener/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@ that configures an [HttpListener](https://docs.microsoft.com/dotnet/api/system.n
88
instance for Prometheus to scrape.
99

1010
> [!WARNING]
11-
> This component is intended for dev inner-loop, there is no plan to
12-
make it production ready. Production environments should use
13-
[OpenTelemetry.Exporter.Prometheus.AspNetCore](../OpenTelemetry.Exporter.Prometheus.AspNetCore/README.md),
14-
or a combination of
15-
[OpenTelemetry.Exporter.OpenTelemetryProtocol](../OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md)
16-
and [OpenTelemetry
17-
Collector](https://github.com/open-telemetry/opentelemetry-collector).
11+
> This component is intended for dev inner-loop, there is no plan to make it
12+
production ready. Production environments should consider using
13+
[OpenTelemetry.Exporter.OpenTelemetryProtocol](../OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md).
14+
Refer to the [Getting Started with Prometheus and
15+
Grafana](../../docs/metrics/getting-started-prometheus-grafana/README.md)
16+
tutorial for more information.
1817

1918
## Prerequisite
2019

0 commit comments

Comments
 (0)