Skip to content

Commit 18e4bd8

Browse files
jaydelucajaydeluca
authored
[chore] Add display names for receivers - batch 4 (#46472)
**Description** Uses the new [display_name](open-telemetry/opentelemetry-collector#14115) and description fields for components. I am breaking up the receivers into batches since there are so many Related to open-telemetry/opentelemetry-collector#14114 and open-telemetry/opentelemetry-collector#14400 Continuation from #45537 #45554 #45599 #45647 #45722 #45883 #45950 #46035 #46055 #46216 #46339
1 parent a6e7210 commit 18e4bd8

File tree

20 files changed

+85
-37
lines changed

20 files changed

+85
-37
lines changed

‎receiver/icmpcheckreceiver/README.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
# icmpcheckreceiver
21
<!-- status autogenerated section -->
2+
# ICMP Check Receiver
3+
4+
The ICMP Check Receiver can be used for synthetic checks against network endpoints. This receiver will send ICMP Echo
5+
Requests (pings) to the specified `targets`. It provides device availability monitoring and interface statistics with
6+
native OpenTelemetry OTLP metrics generation.
7+
8+
39
| Status | |
410
| ------------- |-----------|
511
| Stability | [development]: metrics |
@@ -11,9 +17,6 @@
1117
[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
1218
<!-- end autogenerated section -->
1319

14-
The ICMP Check Receiver can be used for synthetic checks against network endpoints. This receiver will send ICMP Echo Requests (pings)
15-
to the specified `targets`. It provides device availability monitoring and interface statistics with native OpenTelemetry OTLP metrics generation.
16-
1720
## Configuration
1821

1922
The following configuration settings are available:

‎receiver/icmpcheckreceiver/metadata.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1+
display_name: ICMP Check Receiver
12
type: icmpcheckreceiver
23

4+
description: |
5+
The ICMP Check Receiver can be used for synthetic checks against network endpoints. This receiver will send ICMP Echo
6+
Requests (pings) to the specified `targets`. It provides device availability monitoring and interface statistics with
7+
native OpenTelemetry OTLP metrics generation.
8+
39
status:
410
class: receiver
511
stability:

‎receiver/iisreceiver/README.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1+
<!-- status autogenerated section -->
12
# Microsoft IIS Receiver
23

3-
<!-- status autogenerated section -->
4+
The Microsoft IIS Receiver grabs metrics about an IIS instance using the Windows Performance Counters. Because of
5+
this, it is a Windows only receiver.
6+
7+
48
| Status | |
59
| ------------- |-----------|
610
| Stability | [beta]: metrics |
@@ -14,9 +18,6 @@
1418
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
1519
<!-- end autogenerated section -->
1620

17-
The `iis` receiver grabs metrics about an IIS instance using the Windows Performance Counters.
18-
Because of this, it is a Windows only receiver.
19-
2021
## Configuration
2122

2223
The following settings are optional:

‎receiver/iisreceiver/metadata.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1+
display_name: Microsoft IIS Receiver
12
type: iis
23

4+
description: |
5+
The Microsoft IIS Receiver grabs metrics about an IIS instance using the Windows Performance Counters. Because of
6+
this, it is a Windows only receiver.
7+
38
tests:
49
goleak:
510
setup: "setupTestMain(m)"

‎receiver/influxdbreceiver/README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1+
<!-- status autogenerated section -->
12
# InfluxDB Receiver
23

3-
<!-- status autogenerated section -->
4+
This receiver accepts metrics data as [InfluxDB Line Protocol](https://docs.influxdata.com/influxdb/v2.0/reference/syntax/line-protocol/).
5+
6+
47
| Status | |
58
| ------------- |-----------|
69
| Stability | [beta]: metrics |
@@ -13,8 +16,6 @@
1316
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
1417
<!-- end autogenerated section -->
1518

16-
This receiver accepts metrics data as [InfluxDB Line Protocol](https://docs.influxdata.com/influxdb/v2.0/reference/syntax/line-protocol/).
17-
1819
Write endpoints exist at `/write` (InfluxDB 1.x compatibility) and `/api/v2/write` (InfluxDB 2.x compatibility).
1920
Write query parameters `db`/`rp` (InfluxDB 1.x) and `org`/`bucket` (InfluxDB 2.x) are ignored.
2021
Write query parameter `precision` is optional, defaults to `ns`.

‎receiver/influxdbreceiver/metadata.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
display_name: InfluxDB Receiver
12
type: influxdb
23

4+
description: |
5+
This receiver accepts metrics data as [InfluxDB Line Protocol](https://docs.influxdata.com/influxdb/v2.0/reference/syntax/line-protocol/).
6+
37
status:
48
class: receiver
59
stability:

‎receiver/jaegerreceiver/README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1+
<!-- status autogenerated section -->
12
# Jaeger Receiver
23

3-
<!-- status autogenerated section -->
4+
The Jaeger Receiver receives trace data in the [Jaeger](https://www.jaegertracing.io/) format.
5+
6+
47
| Status | |
58
| ------------- |-----------|
69
| Stability | [beta]: traces |
@@ -15,8 +18,6 @@
1518
[k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s
1619
<!-- end autogenerated section -->
1720

18-
Receives trace data in [Jaeger](https://www.jaegertracing.io/) format.
19-
2021
## Getting Started
2122

2223
By default, the Jaeger receiver will not serve any protocol. A protocol must be

‎receiver/jaegerreceiver/metadata.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
display_name: Jaeger Receiver
12
type: jaeger
23

4+
description: |
5+
The Jaeger Receiver receives trace data in the [Jaeger](https://www.jaegertracing.io/) format.
6+
37
status:
48
class: receiver
59
stability:

‎receiver/jmxreceiver/README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# JMX Receiver
2-
31
<!-- status autogenerated section -->
2+
# JMX Receiver
43
| Status | |
54
| ------------- |-----------|
65
| Stability | [deprecated]: metrics |

‎receiver/jmxreceiver/metadata.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
display_name: JMX Receiver
12
type: jmx
23

34
status:

0 commit comments

Comments
 (0)