Skip to content

Commit

Permalink
[docs] [chore] Update Development stability links in the Readme heade…
Browse files Browse the repository at this point in the history
…rs (#16334)
  • Loading branch information
dmitryax authored Nov 16, 2022
1 parent 120f3e4 commit 8b21f98
Show file tree
Hide file tree
Showing 16 changed files with 88 additions and 81 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This is a repository for OpenTelemetry Collector components that are not suitabl

The official distributions, core and contrib, are available as part of the [opentelemetry-collector-releases](https://github.com/open-telemetry/opentelemetry-collector-releases) repository. Some of the components in this repository are part of the "core" distribution, such as the Jaeger and Prometheus components, but most of the components here are only available as part of the "contrib" distribution. Users of the OpenTelemetry Collector are also encouraged to build their own custom distributions with the [OpenTelemetry Collector Builder](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder), using the components they need from the core repository, the contrib repository, and possibly third-party or internal repositories.

Each component has its own support levels, as defined in the following sections. For each signal that a component supports, there's a stability level, setting the right expectations. It is possible then that a component will be **Stable** for traces but **Alpha** for metrics and **In Development** for logs.
Each component has its own support levels, as defined in the following sections. For each signal that a component supports, there's a stability level, setting the right expectations. It is possible then that a component will be **Stable** for traces but **Alpha** for metrics and **Development** for logs.

## Stability levels

Expand Down
13 changes: 7 additions & 6 deletions cmd/telemetrygen/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# Telemetry generator for OpenTelemetry

| Status | |
| ------------------------ | --------------------- |
| Stability | traces [WIP] |
| | metrics [WIP] |
| Supported signal types | traces, metrics |
| Status | |
| ------------------------ |-----------------|
| Stability | [development] |
| Supported signal types | traces, metrics |

This utility simulates a client generating **traces** and **metrics**, useful for testing and demonstration purposes.

Expand All @@ -27,4 +26,6 @@ telemetrygen traces

```
telemetrygen metrics
```
```

[development]: https://github.com/open-telemetry/opentelemetry-collector#development
4 changes: 2 additions & 2 deletions exporter/parquetexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

| Status | |
| ------------------------ |-----------------------|
| Stability | [in-development] |
| Stability | [development] |
| Supported pipeline types | traces, logs, metrics |
| Distributions | none |

Expand All @@ -29,4 +29,4 @@ exporters:
The full list of settings exposed for this exporter is going to be documented later
with detailed sample configurations [here](testdata/config.yaml).
[in-development]:https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
12 changes: 6 additions & 6 deletions processor/deltatorateprocessor/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Delta to Rate Processor

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

**Status: under development; Not recommended for production usage.**

Expand Down Expand Up @@ -32,5 +32,5 @@ processors:
- <metric_n_name>
```
[in development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
12 changes: 6 additions & 6 deletions processor/logstransformprocessor/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Logs Transform Processor

| Status | |
|--------------------------|------------------|
| Stability | [in development] |
| Supported pipeline types | logs |
| Distributions | none |
| Status | |
|--------------------------|---------------|
| Stability | [development] |
| Supported pipeline types | logs |
| Distributions | none |

NOTE - This processor is experimental, with the intention that its functionality will be reimplemented in the [transform processor](../transformprocessor/README.md) in the future.

Expand All @@ -29,4 +29,4 @@ processors:
Refer to [config.yaml](./testdata/config.yaml) for detailed
examples on using the processor.
[in development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
12 changes: 6 additions & 6 deletions processor/metricsgenerationprocessor/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Metrics Generation Processor

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

**Status: under development; Not recommended for production usage.**

Expand Down Expand Up @@ -72,5 +72,5 @@ rules:
scale_by: 1048576
```
[in development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
6 changes: 3 additions & 3 deletions processor/schemaprocessor/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Schema Transformer Processor

| Status | |
| ------------------------ | --------------------- |
| Stability | [in development] |
| ------------------------ |-----------------------|
| Stability | [development] |
| Supported pipeline types | metrics, traces, logs |
| Distributions | none |

Expand Down Expand Up @@ -55,4 +55,4 @@ processors:
For more complete examples, please refer to [config.yml](./testdata/config.yml).
[in development]:https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
12 changes: 6 additions & 6 deletions processor/spanmetricsprocessor/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Span Metrics Processor

| Status | |
| ------------------------ |---------------------|
| Stability | [in development] |
| Supported pipeline types | traces |
| Distributions | [contrib] |
| Status | |
| ------------------------ |---------------|
| Stability | [development] |
| Supported pipeline types | traces |
| Distributions | [contrib] |

**Note:** Currently experimental and subject to breaking changes (e.g. change from processor to exporter/translator component).
See: https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/403.
Expand Down Expand Up @@ -138,5 +138,5 @@ service:
For more example configuration covering various other use cases, please visit the [testdata directory](./testdata).
[in development]:https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
12 changes: 7 additions & 5 deletions receiver/azureblobreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Azure Blob Receiver

| Status | |
| ------------------------ | ----------- |
| Stability |[development]|
| Supported pipeline types | logs,traces |
| Distributions | [contrib] |
| Status | |
| ------------------------ |---------------|
| Stability | [development] |
| Supported pipeline types | logs,traces |
| Distributions | [contrib] |


This receiver reads logs and trace data from [Azure Blob Storage](https://azure.microsoft.com/services/storage/blobs/).
Expand Down Expand Up @@ -35,3 +35,5 @@ receivers:
```
The receiver subscribes [on the events](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-event-overview) published by Azure Blob Storage and handled by Azure Event Hub. When it receives `Blob Create` event, it reads the logs or traces from a corresponding blob and deletes it after processing.

[development]: https://github.com/open-telemetry/opentelemetry-collector#development
12 changes: 6 additions & 6 deletions receiver/httpcheckreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# HTTP Check Receiver

| Status | |
| ------------------------ |------------------|
| Stability | [in development] |
| Supported pipeline types | metrics |
| Distributions | none |
| Status | |
| ------------------------ |---------------|
| Stability | [development] |
| Supported pipeline types | metrics |
| Distributions | none |

The HTTP Check Receiver can be used for synthethic checks against HTTP endpoints. This receiver will make a request to the specified `endpoint` using the
configured `method`. This scraper generates a metric with a label for each HTTP response status class with a value of `1` if the status code matches the
Expand Down Expand Up @@ -43,5 +43,5 @@ receivers:
Details about the metrics produced by this receiver can be found in [documentation.md](./documentation.md)
[in development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
12 changes: 7 additions & 5 deletions receiver/oracledbreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Oracle DB receiver

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

This receiver collects metrics from an Oracle Database.

The receiver connects to a database host and performs periodically queries.

[development]: https://github.com/open-telemetry/opentelemetry-collector#development
12 changes: 6 additions & 6 deletions receiver/podmanreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Podman Stats Receiver

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

The Podman Stats receiver queries the Podman service API to fetch stats for all running containers
on a configured interval. These stats are for container
Expand Down Expand Up @@ -89,5 +89,5 @@ Recommended build tags to use when including this receiver in your build:
- `exclude_graphdriver_btrfs`
- `exclude_graphdriver_devicemapper`

[in development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
12 changes: 6 additions & 6 deletions receiver/saphanareceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# SAP HANA Receiver

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

This receiver can fetch stats from a SAP HANA instance. It leverages the [driver](https://github.com/SAP/go-hdb) written by SAP for connecting to SAP HANA with the golang sql module to execute several monitoring queries.

Expand Down Expand Up @@ -95,4 +95,4 @@ Details about the metrics produced by this receiver can be found in [metadata.ya
> If all of the metrics collected by a given monitoring query are marked as `enabled: false` in the receiver configration, the monitoring query will not be executed.

[in-development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
12 changes: 6 additions & 6 deletions receiver/snmpreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# SNMP Receiver

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

This receiver fetches stats from a SNMP enabled host using a [golang
snmp client](https://github.com/gosnmp/gosnmp). Metrics are collected
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).

[in development]:https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
12 changes: 7 additions & 5 deletions receiver/snowflakereceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Snowflake Receiver

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

This receiver collects metrics from a Snowflake account by connecting to an account and running queries at set intervals.

[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
12 changes: 6 additions & 6 deletions receiver/zookeeperreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Zookeeper Receiver

| Status | |
| ------------------------ | ---------------- |
| Stability | [in development] |
| Supported pipeline types | traces |
| Distributions | [contrib] |
| Status | |
| ------------------------ |---------------|
| Stability | [development] |
| Supported pipeline types | traces |
| Distributions | [contrib] |

The Zookeeper receiver collects metrics from a Zookeeper instance, using the `mntr` command. The `mntr` 4 letter word command needs
to be enabled for the receiver to be able to collect metrics.
Expand All @@ -27,5 +27,5 @@ receivers:
Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml) with further documentation in [documentation.md](./documentation.md)
[in development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

0 comments on commit 8b21f98

Please sign in to comment.