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

<!-- status autogenerated section -->
The OpenTelemetry **Verbatim Capture & Replay (VCR) toolset** enables full-fidelity capture and replay of all
telemetry data stored on disk. It replays previously captured telemetry while **preserving original event timestamps**,
allowing you to simulate realistic traffic timing independent of when the data was captured.


| Status | |
| ------------- |-----------|
| Stability | [development]: traces, metrics, logs, profiles |
Expand All @@ -14,8 +19,6 @@

## Overview

The OpenTelemetry **Verbatim Capture & Replay (VCR) toolset** enables full-fidelity capture and replay of all telemetry data stored on disk. It replays previously captured telemetry while **preserving original event timestamps**, allowing you to simulate realistic traffic timing independent of when the data was captured.

The receiver reads telemetry from JSON files stored in a **"TAPE" (Telemetry Archive for Playback & Emulation)**. Each tape contains OpenTelemetry data encoded using **Protobuf JSON** and follows the OpenTelemetry Protocol (OTLP).

### 1. Raw Input Files
Expand Down
6 changes: 6 additions & 0 deletions receiver/vcrreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
display_name: VCR Receiver
type: vcr

description: |
The OpenTelemetry **Verbatim Capture & Replay (VCR) toolset** enables full-fidelity capture and replay of all
telemetry data stored on disk. It replays previously captured telemetry while **preserving original event timestamps**,
allowing you to simulate realistic traffic timing independent of when the data was captured.

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

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

status:
Expand Down
12 changes: 7 additions & 5 deletions receiver/webhookeventreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
<!-- status autogenerated section -->
# Webhook Event Receiver

<!-- status autogenerated section -->
The Webhook Event Receiver is a push based event collector component meant to act as a generally available receiver
for any webhook style data source. It is designed to work alongside other pipeline components like the
[transform processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor)
to allow the ingestion of generic events as logs into the opentelemetry collector.


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

The Webhook Event Receiver is a push based event collector component meant to act as a generally available receiver for any webhook style data source. It is designed to work alongside other pipeline components
like the [transform processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor) to allow the ingestion of generic events as logs into the opentelemetry
collector.

## Configuration

The following settings are required:
Expand Down
7 changes: 7 additions & 0 deletions receiver/webhookeventreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
display_name: Webhook Event Receiver
type: webhookevent

description: |
The Webhook Event Receiver is a push based event collector component meant to act as a generally available receiver
for any webhook style data source. It is designed to work alongside other pipeline components like the
[transform processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor)
to allow the ingestion of generic events as logs into the opentelemetry collector.

status:
class: receiver
stability:
Expand Down
10 changes: 6 additions & 4 deletions receiver/windowseventlogreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
## Windows Event Log Receiver

<!-- status autogenerated section -->
# Windows Event Log Receiver

This receiver tails and parses logs from windows event log API using the
[opentelemetry-log-collection](https://github.com/open-telemetry/opentelemetry-log-collection) library.


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

Tails and parses logs from windows event log API using the [opentelemetry-log-collection](https://github.com/open-telemetry/opentelemetry-log-collection) library.

### Configuration Fields

| Field | Default | Description |
Expand Down
5 changes: 5 additions & 0 deletions receiver/windowseventlogreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
display_name: Windows Event Log Receiver
type: windowseventlog

description: |
This receiver tails and parses logs from windows event log API using the
[opentelemetry-log-collection](https://github.com/open-telemetry/opentelemetry-log-collection) library.

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

<!-- status autogenerated section -->
This receiver, for Windows only, captures the configured system, application, or
custom performance counter data from the Windows registry using the [PDH
interface](https://docs.microsoft.com/en-us/windows/win32/perfctrs/using-the-pdh-functions-to-consume-counter-data).


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

This receiver, for Windows only, captures the configured system, application, or
custom performance counter data from the Windows registry using the [PDH
interface](https://docs.microsoft.com/en-us/windows/win32/perfctrs/using-the-pdh-functions-to-consume-counter-data).
It is based on the [Telegraf Windows Performance Counters Input
This receiver is based on the [Telegraf Windows Performance Counters Input
Plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/win_perf_counters).

If one of the specified performance counters cannot be loaded on startup, a
Expand Down
6 changes: 6 additions & 0 deletions receiver/windowsperfcountersreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
display_name: Windows Performance Counters Receiver
type: windowsperfcounters

description: |
This receiver, for Windows only, captures the configured system, application, or
custom performance counter data from the Windows registry using the [PDH
interface](https://docs.microsoft.com/en-us/windows/win32/perfctrs/using-the-pdh-functions-to-consume-counter-data).

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

<!-- status autogenerated section -->
The Windows Service Receiver is a receiver for scraping information about the state of services running on a Windows
machine.


| Status | |
| ------------- |-----------|
| Stability | [development]: 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 Windows Service Receiver is a receiver for scraping information about the state of services running on a Windows machine.

## Getting Started

By default the Windows Service Receiver will attempt to identify and monitor the status of all specified services on the host machine.
Expand Down
5 changes: 5 additions & 0 deletions receiver/windowsservicereceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
display_name: Windows Service Receiver
type: windowsservice

description: |
The Windows Service Receiver is a receiver for scraping information about the state of services running on a Windows
machine.

status:
class: receiver
stability:
Expand Down
13 changes: 8 additions & 5 deletions receiver/yanggrpcreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# YANG gRPC receiver

<!-- status autogenerated section -->
# YANG gRPC Receiver

The YANG/gRPC receiver receives metrics offered using the
[YANG (Yet Another New Generation) data model](https://en.wikipedia.org/wiki/YANG), expressed over
[gRPC](https://ciscolearning.github.io/cisco-learning-codelabs/posts/yangsuite-restconf/#0).


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

The YANG/gRPC receiver receives metrics offered using the [YANG (Yet Another New Generation) data model](https://en.wikipedia.org/wiki/YANG), expressed over [gRPC](https://ciscolearning.github.io/cisco-learning-codelabs/posts/yangsuite-restconf/#0).

The receiver exposes a gRPC endpoint, accepting the gRPC configuration offered by the [configgrpc](https://pkg.go.dev/go.opentelemetry.io/collector/config/configgrpc) module.
This receiver exposes a gRPC endpoint, accepting the gRPC configuration offered by the [configgrpc](https://pkg.go.dev/go.opentelemetry.io/collector/config/configgrpc) module.

# Configuration

Expand Down
6 changes: 6 additions & 0 deletions receiver/yanggrpcreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
display_name: YANG gRPC Receiver
type: yang_grpc
deprecated_type: yanggrpc

description: |
The YANG/gRPC receiver receives metrics offered using the
[YANG (Yet Another New Generation) data model](https://en.wikipedia.org/wiki/YANG), expressed over
[gRPC](https://ciscolearning.github.io/cisco-learning-codelabs/posts/yangsuite-restconf/#0).

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

<!-- status autogenerated section -->
This receiver receives spans from [Zipkin](https://zipkin.io/) (V1 and V2).


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

This receiver receives spans from [Zipkin](https://zipkin.io/) (V1 and V2).

## Getting Started

All that is required to enable the Zipkin receiver is to include it in the
Expand Down
4 changes: 4 additions & 0 deletions receiver/zipkinreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: Zipkin Receiver
type: zipkin

description: |
This receiver receives spans from [Zipkin](https://zipkin.io/) (V1 and V2).

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

<!-- status autogenerated section -->
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.


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

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.

## Configuration

- `endpoint`: (default = `localhost:2181`) Endpoint to connect to collect metrics. Takes the form `host:port`. See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
Expand Down
5 changes: 5 additions & 0 deletions receiver/zookeeperreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
display_name: Zookeeper Receiver
type: zookeeper

description: |
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.

status:
class: receiver
stability:
Expand Down
9 changes: 5 additions & 4 deletions scraper/zookeeperscraper/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<!-- status autogenerated section -->
# Zookeeper Scraper

<!-- status autogenerated section -->
The Zookeeper scraper collects metrics from a Zookeeper instance, using the `mntr` command. The `mntr` 4 letter word
command needs to be enabled for the scraper to be able to collect metrics.


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

The Zookeeper scraper collects metrics from a Zookeeper instance, using the `mntr` command. The `mntr` 4 letter word command needs
to be enabled for the scraper to be able to collect metrics.

## Configuration

- `endpoint`: (default = `localhost:2181`) Endpoint to connect to collect metrics. Takes the form `host:port`. See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments.
Expand Down
5 changes: 5 additions & 0 deletions scraper/zookeeperscraper/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
display_name: Zookeeper Scraper
type: zookeeper

description: |
The Zookeeper scraper collects metrics from a Zookeeper instance, using the `mntr` command. The `mntr` 4 letter word
command needs to be enabled for the scraper to be able to collect metrics.

status:
class: scraper
stability:
Expand Down
Loading