Skip to content
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
7 changes: 4 additions & 3 deletions receiver/postgresqlreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<!-- status autogenerated section -->
# PostgreSQL Receiver

<!-- status autogenerated section -->
This receiver queries the PostgreSQL [statistics collector](https://www.postgresql.org/docs/13/monitoring-stats.html).


| Status | |
| ------------- |-----------|
| Stability | [development]: logs |
Expand All @@ -16,8 +19,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

This receiver queries the PostgreSQL [statistics collector](https://www.postgresql.org/docs/13/monitoring-stats.html).

## Prerequisites

See PostgreSQL documentation for [supported versions](https://www.postgresql.org/support/versioning).
Expand Down
4 changes: 4 additions & 0 deletions receiver/postgresqlreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: PostgreSQL Receiver
type: postgresql

description: |
This receiver queries the PostgreSQL [statistics collector](https://www.postgresql.org/docs/13/monitoring-stats.html).

status:
class: receiver
stability:
Expand Down
7 changes: 4 additions & 3 deletions receiver/pprofreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<!-- status autogenerated section -->
# Pprof Receiver

<!-- status autogenerated section -->
The Pprof Receiver collects profiles from files specified with a glob pattern.


| Status | |
| ------------- |-----------|
| Stability | [development]: profiles |
Expand All @@ -12,8 +15,6 @@
[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
<!-- end autogenerated section -->

Collects profiles from files specified with a glob pattern.

## Configuration
- `include` (required): The glob path for files to watch
- `collection_interval` (default = `1m`): The interval at which metrics are emitted by this receiver.
Expand Down
4 changes: 4 additions & 0 deletions receiver/pprofreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: Pprof Receiver
type: pprof

description: |
The Pprof Receiver collects profiles from files specified with a glob pattern.

status:
class: receiver
stability:
Expand Down
8 changes: 5 additions & 3 deletions receiver/prometheusreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<!-- status autogenerated section -->
# Prometheus Receiver

<!-- status autogenerated section -->
The Prometheus Receiver receives metric data in [Prometheus](https://prometheus.io/) format.


| Status | |
| ------------- |-----------|
| Stability | [beta]: metrics |
Expand All @@ -15,8 +18,7 @@
[k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s
<!-- end autogenerated section -->

Receives metric data in [Prometheus](https://prometheus.io/) format. See the
[Design](DESIGN.md) for additional information on this receiver.
See the [Design](DESIGN.md) for additional information on this receiver.

## ⚠️ Warning

Expand Down
4 changes: 4 additions & 0 deletions receiver/prometheusreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: Prometheus Receiver
type: prometheus

description: |
The Prometheus Receiver receives metric data in [Prometheus](https://prometheus.io/) format.

status:
class: receiver
stability:
Expand Down
9 changes: 7 additions & 2 deletions receiver/prometheusremotewritereceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<!-- status autogenerated section -->
# Prometheus Remote Write Receiver

<!-- status autogenerated section -->
This receiver implements the
[Prometheus Remote Write 2.0 protocol](https://prometheus.io/docs/specs/prw/remote_write_spec_2_0/).


| Status | |
| ------------- |-----------|
| Stability | [alpha]: metrics |
Expand All @@ -15,7 +19,8 @@

## Prometheus Compatibility

This receiver implements the [Prometheus Remote Write 2.0 protocol](https://prometheus.io/docs/specs/prw/remote_write_spec_2_0/), which is still evolving. As the protocol specification changes, we update our implementation to match, which can affect compatibility with different Prometheus versions.
The [Prometheus Remote Write 2.0 protocol](https://prometheus.io/docs/specs/prw/remote_write_spec_2_0/) is still evolving.
As the protocol specification changes, we update our implementation to match, which can affect compatibility with different Prometheus versions.

| OTel Collector Contrib Version | Compatible Prometheus Versions |
|-------------------------------|-------------------------------|
Expand Down
5 changes: 5 additions & 0 deletions receiver/prometheusremotewritereceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
display_name: Prometheus Remote Write Receiver
type: prometheusremotewrite

description: |
This receiver implements the
[Prometheus Remote Write 2.0 protocol](https://prometheus.io/docs/specs/prw/remote_write_spec_2_0/).

status:
class: receiver
stability:
Expand Down
7 changes: 4 additions & 3 deletions receiver/pulsarreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<!-- status autogenerated section -->
# Pulsar Receiver

<!-- status autogenerated section -->
The Pulsar Receiver receives logs, metrics, and traces from [Apache Pulsar](https://pulsar.apache.org/).


| Status | |
| ------------- |-----------|
| Stability | [alpha]: metrics, traces, logs |
Expand All @@ -14,8 +17,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

Pulsar receiver receives logs, metrics, and traces from [Apache Pulsar](https://pulsar.apache.org/).

## Getting Started

The following settings can be optionally configured:
Expand Down
4 changes: 4 additions & 0 deletions receiver/pulsarreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: Pulsar Receiver
type: pulsar

description: |
The Pulsar Receiver receives logs, metrics, and traces from [Apache Pulsar](https://pulsar.apache.org/).

status:
class: receiver
stability:
Expand Down
7 changes: 4 additions & 3 deletions receiver/purefareceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<!-- status autogenerated section -->
# Pure Storage FlashArray Receiver

<!-- status autogenerated section -->
The Pure Storage FlashArray Receiver receives metrics from the Pure Storage FlashArray.


| Status | |
| ------------- |-----------|
| Stability | [alpha]: metrics |
Expand All @@ -14,8 +17,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

The Pure Storage FlashArray receiver, receives metrics from the Pure Storage FlashArray.

## Configuration

The following settings are required:
Expand Down
4 changes: 4 additions & 0 deletions receiver/purefareceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: Pure Storage FlashArray Receiver
type: purefa

description: |
The Pure Storage FlashArray Receiver receives metrics from the Pure Storage FlashArray.

status:
class: receiver
stability:
Expand Down
8 changes: 5 additions & 3 deletions receiver/purefbreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<!-- status autogenerated section -->
# Pure Storage FlashBlade Receiver

<!-- status autogenerated section -->
The Pure Storage FlashBlade receiver, receives metrics from Pure Storage FlashBlade via the
[Pure Storage FlashBlade OpenMetrics Exporter](https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter)


| Status | |
| ------------- |-----------|
| Stability | [alpha]: metrics |
Expand All @@ -14,8 +18,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

The Pure Storage FlashBlade receiver, receives metrics from Pure Storage FlashBlade via the [Pure Storage FlashBlade OpenMetrics Exporter](https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter)

## Configuration

The following settings are required:
Expand Down
6 changes: 6 additions & 0 deletions receiver/purefbreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
display_name: Pure Storage FlashBlade Receiver
type: purefb

description: |
The Pure Storage FlashBlade receiver, receives metrics from Pure Storage FlashBlade via the
[Pure Storage FlashBlade OpenMetrics Exporter](https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter)


status:
class: receiver
stability:
Expand Down
7 changes: 4 additions & 3 deletions receiver/rabbitmqreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<!-- status autogenerated section -->
# RabbitMQ Receiver

<!-- status autogenerated section -->
This receiver fetches stats from a RabbitMQ node using the [RabbitMQ Management Plugin](https://www.rabbitmq.com/management.html).


| Status | |
| ------------- |-----------|
| Stability | [beta]: metrics |
Expand All @@ -14,8 +17,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

This receiver fetches stats from a RabbitMQ node using the [RabbitMQ Management Plugin](https://www.rabbitmq.com/management.html).

## Prerequisites

This receiver supports RabbitMQ versions `3.8` and `3.9`.
Expand Down
4 changes: 4 additions & 0 deletions receiver/rabbitmqreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: RabbitMQ Receiver
type: rabbitmq

description: |
This receiver fetches stats from a RabbitMQ node using the [RabbitMQ Management Plugin](https://www.rabbitmq.com/management.html).

tests: # generated_component_test.go looking for test.config from metadata.yaml
config:
endpoint: "http://localhost:15672"
Expand Down
9 changes: 5 additions & 4 deletions receiver/receivercreator/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<!-- status autogenerated section -->
# Receiver Creator

<!-- status autogenerated section -->
This receiver can instantiate other receivers at runtime based on whether observed endpoints match a configured rule.


| Status | |
| ------------- |-----------|
| Stability | [alpha]: logs, traces |
Expand All @@ -17,9 +20,7 @@
[k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s
<!-- end autogenerated section -->

This receiver can instantiate other receivers at runtime based on whether
observed endpoints match a configured rule. To use the receiver creator, you
must first configure one or more
To use the receiver creator, you must first configure one or more
[observers](../../extension/observer/README.md) that will discover networked
endpoints that you may be interested in. The configured rules will be
evaluated for each endpoint discovered. If the rule evaluates to true then
Expand Down
4 changes: 4 additions & 0 deletions receiver/receivercreator/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: Receiver Creator
type: receiver_creator

description: |
This receiver can instantiate other receivers at runtime based on whether observed endpoints match a configured rule.

status:
class: receiver
stability:
Expand Down
8 changes: 5 additions & 3 deletions receiver/redfishreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<!-- status autogenerated section -->
# Redfish Receiver

<!-- status autogenerated section -->
This receiver fetches metrics for a server running a [Redfish](https://en.wikipedia.org/wiki/Redfish_(specification))
API.


| Status | |
| ------------- |-----------|
| Stability | [development]: metrics |
Expand All @@ -12,8 +16,6 @@
[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
<!-- end autogenerated section -->

This receiver fetches metrics for a server running a [Redfish](https://en.wikipedia.org/wiki/Redfish_(specification)) API.

## Purpose

The purpose of this component is to monitor devices running a Redfish API which is quite often a BMC (Baseboard Management Controller) such as; Dell iDRAC, HPE iLO, etc.
Expand Down
5 changes: 5 additions & 0 deletions receiver/redfishreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
display_name: Redfish Receiver
type: redfish

description: |
This receiver fetches metrics for a server running a [Redfish](https://en.wikipedia.org/wiki/Redfish_(specification))
API.

status:
class: receiver
stability:
Expand Down
11 changes: 6 additions & 5 deletions receiver/redisreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
<!-- status autogenerated section -->
# Redis Receiver

<!-- status autogenerated section -->
The Redis Receiver is designed to retrieve Redis INFO data from a single Redis
instance, build metrics from that data, and send them to the next consumer at a
configurable interval.


| Status | |
| ------------- |-----------|
| Stability | [beta]: metrics |
Expand All @@ -13,10 +18,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

The Redis receiver is designed to retrieve Redis INFO data from a single Redis
instance, build metrics from that data, and send them to the next consumer at a
configurable interval.

## Details

The Redis INFO command returns information and statistics about a Redis
Expand Down
6 changes: 6 additions & 0 deletions receiver/redisreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
display_name: Redis Receiver
type: redis

description: |
The Redis Receiver is designed to retrieve Redis INFO data from a single Redis
instance, build metrics from that data, and send them to the next consumer at a
configurable interval.

reaggregation_enabled: true

status:
Expand Down
3 changes: 1 addition & 2 deletions receiver/riakreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Riak Receiver

<!-- status autogenerated section -->
# Riak Receiver
| Status | |
| ------------- |-----------|
| Stability | [beta]: metrics |
Expand Down
1 change: 1 addition & 0 deletions receiver/riakreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
display_name: Riak Receiver
type: riak

status:
Expand Down
Loading