Skip to content

Commit

Permalink
[chore] add Splunk distribution (open-telemetry#22031)
Browse files Browse the repository at this point in the history
This adds to the metadata.yaml or README.md files a mention of the inclusion of some of the components as part of the official Splunk distribution.
  • Loading branch information
atoulme committed May 17, 2023
1 parent ad56ae6 commit 60f5708
Show file tree
Hide file tree
Showing 108 changed files with 217 additions and 156 deletions.
11 changes: 6 additions & 5 deletions exporter/fileexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# File Exporter

| Status | |
| ------------------------ | --------------------- |
| Stability | [alpha] |
| Supported pipeline types | traces, metrics, logs |
| Distributions | [core], [contrib] |
| Status | |
| ------------------------ |-----------------------------|
| Stability | [alpha] |
| Supported pipeline types | traces, metrics, logs |
| Distributions | [core], [contrib], [splunk] |

Exporter supports the following features:

Expand Down Expand Up @@ -135,3 +135,4 @@ EOF
[alpha]:https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[core]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
[splunk]: https://github.com/signalfx/splunk-otel-collector
9 changes: 5 additions & 4 deletions exporter/kafkaexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Kafka Exporter

| Status | |
| ------------------------ |-----------------------|
| Stability | [beta] |
| Status | |
| ------------------------ |----------------------|
| Stability | [beta] |
| Supported pipeline types | traces, logs, metrics |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

Kafka exporter exports logs, metrics, and traces to Kafka. This exporter uses a synchronous producer
that blocks and does not batch messages, therefore it should be used with batch and queued retry
Expand Down Expand Up @@ -90,3 +90,4 @@ exporters:

[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
3 changes: 2 additions & 1 deletion exporter/sapmexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
| Status | |
| ------------- |-----------|
| Stability | [beta]: traces |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

The SAPM exporter builds on the Jaeger proto and adds additional batching on top. This allows
Expand Down
2 changes: 1 addition & 1 deletion exporter/sapmexporter/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: exporter
stability:
beta: [traces]
distributions: [contrib]
distributions: [contrib, splunk]
3 changes: 2 additions & 1 deletion exporter/signalfxexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
| Status | |
| ------------- |-----------|
| Stability | [beta]: traces, metrics, logs |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

This exporter can be used to send metrics, events, and trace correlation to SignalFx.
Expand Down
2 changes: 1 addition & 1 deletion exporter/signalfxexporter/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: exporter
stability:
beta: [traces, metrics, logs]
distributions: [contrib]
distributions: [contrib, splunk]
3 changes: 2 additions & 1 deletion exporter/splunkhecexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
| Status | |
| ------------- |-----------|
| Stability | [beta]: traces, metrics, logs |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

## Configuration
Expand Down
2 changes: 1 addition & 1 deletion exporter/splunkhecexporter/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: exporter
stability:
beta: [traces, metrics, logs]
distributions: [contrib]
distributions: [contrib, splunk]
3 changes: 2 additions & 1 deletion extension/healthcheckextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
| Status | |
| ------------- |-----------|
| Stability | [beta] |
| Distributions | [core], [contrib] |
| Distributions | [core], [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[core]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

Health Check extension enables an HTTP url that can be probed to check the
Expand Down
2 changes: 1 addition & 1 deletion extension/healthcheckextension/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: extension
stability:
beta: [extension]
distributions: [core, contrib]
distributions: [core, contrib, splunk]
3 changes: 2 additions & 1 deletion extension/httpforwarder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
| Status | |
| ------------- |-----------|
| Stability | [beta] |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

This extension accepts HTTP requests, optionally adds headers to them and forwards them.
Expand Down
2 changes: 1 addition & 1 deletion extension/httpforwarder/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: extension
stability:
beta: [extension]
distributions: [contrib]
distributions: [contrib, splunk]
3 changes: 2 additions & 1 deletion extension/observer/dockerobserver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
| Status | |
| ------------- |-----------|
| Stability | [beta] |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

The Docker observer extension is a [Receiver Creator](../../../receiver/receivercreator/README.md)-compatible "watch observer" that will detect and report
Expand Down
2 changes: 1 addition & 1 deletion extension/observer/dockerobserver/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: extension
stability:
beta: [extension]
distributions: [contrib]
distributions: [contrib, splunk]
3 changes: 2 additions & 1 deletion extension/observer/ecsobserver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
| Status | |
| ------------- |-----------|
| Stability | [beta] |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

The `ecsobserver` uses the ECS/EC2 API to discover prometheus scrape targets from all running tasks and filter them
Expand Down
2 changes: 1 addition & 1 deletion extension/observer/ecsobserver/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: extension
stability:
beta: [extension]
distributions: [contrib]
distributions: [contrib, splunk]
3 changes: 2 additions & 1 deletion extension/observer/ecstaskobserver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
| Status | |
| ------------- |-----------|
| Stability | [beta] |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

The `ecs_task_observer` is a [Receiver Creator](../../../receiver/receivercreator/README.md)-compatible "watch observer" that will detect and report
Expand Down
2 changes: 1 addition & 1 deletion extension/observer/ecstaskobserver/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: extension
stability:
beta: [extension]
distributions: [contrib]
distributions: [contrib, splunk]
3 changes: 2 additions & 1 deletion extension/observer/hostobserver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
| Status | |
| ------------- |-----------|
| Stability | [beta] |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

The `host_observer` looks at the current host for listening network endpoints.
Expand Down
2 changes: 1 addition & 1 deletion extension/observer/hostobserver/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: extension
stability:
beta: [extension]
distributions: [contrib]
distributions: [contrib, splunk]
3 changes: 2 additions & 1 deletion extension/observer/k8sobserver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
| Status | |
| ------------- |-----------|
| Stability | [alpha] |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

The `k8s_observer` is a [Receiver Creator](../../../receiver/receivercreator/README.md)-compatible "watch observer" that will detect and report
Expand Down
2 changes: 1 addition & 1 deletion extension/observer/k8sobserver/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: extension
stability:
alpha: [extension]
distributions: [contrib]
distributions: [contrib, splunk]
3 changes: 2 additions & 1 deletion extension/pprofextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
| Status | |
| ------------- |-----------|
| Stability | [beta] |
| Distributions | [core], [contrib] |
| Distributions | [core], [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[core]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

Performance Profiler extension enables the golang `net/http/pprof` endpoint.
Expand Down
2 changes: 1 addition & 1 deletion extension/pprofextension/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: extension
stability:
beta: [extension]
distributions: [core, contrib]
distributions: [core, contrib, splunk]
9 changes: 5 additions & 4 deletions extension/storage/filestorage/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# File Storage

| Status | |
| ------------------------ |----------------------|
| Stability | [beta] |
| Distributions | [contrib] |
| Status | |
| ------------------------ |---------------------|
| Stability | [beta] |
| Distributions | [contrib], [splunk] |

The File Storage extension can persist state to the local file system.

Expand Down Expand Up @@ -88,3 +88,4 @@ exporters:

[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
3 changes: 2 additions & 1 deletion processor/attributesprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@
| Status | |
| ------------- |-----------|
| Stability | [beta]: traces, metrics, logs |
| Distributions | [core], [contrib] |
| Distributions | [core], [contrib], [splunk] |
| Warnings | [Identity Conflict](#warnings) |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[core]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

The attributes processor modifies attributes of a span, log, or metric. Please refer to
Expand Down
2 changes: 1 addition & 1 deletion processor/attributesprocessor/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ status:
class: processor
stability:
beta: [traces, metrics, logs]
distributions: [core, contrib]
distributions: [core, contrib, splunk]
warnings: [Identity Conflict]
3 changes: 2 additions & 1 deletion processor/filterprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
| Status | |
| ------------- |-----------|
| Stability | [alpha]: traces, metrics, logs |
| Distributions | [core], [contrib] |
| Distributions | [core], [contrib], [splunk] |
| Warnings | [Orphaned Telemetry, Other](#warnings) |

[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
[core]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

The filterprocessor allows dropping spans, span events, metrics, datapoints, and logs from the collector.
Expand Down
2 changes: 1 addition & 1 deletion processor/filterprocessor/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ status:
class: processor
stability:
alpha: [traces, metrics, logs]
distributions: [core,contrib]
distributions: [core,contrib, splunk]
warnings: [Orphaned Telemetry, Other]
3 changes: 2 additions & 1 deletion processor/groupbyattrsprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
| Status | |
| ------------- |-----------|
| Stability | [beta]: traces, metrics, logs |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

## Description
Expand Down
2 changes: 1 addition & 1 deletion processor/groupbyattrsprocessor/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ status:
class: processor
stability:
beta: [traces, metrics, logs]
distributions: [contrib]
distributions: [contrib, splunk]
warnings: []
3 changes: 2 additions & 1 deletion processor/k8sattributesprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
| Status | |
| ------------- |-----------|
| Stability | [beta]: logs, metrics, traces |
| Distributions | [contrib] |
| Distributions | [contrib], [splunk] |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[splunk]: https://github.com/signalfx/splunk-otel-collector
<!-- end autogenerated section -->

Kubernetes attributes processor allow automatic setting of spans, metrics and logs resource attributes with k8s metadata.
Expand Down
2 changes: 1 addition & 1 deletion processor/k8sattributesprocessor/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ status:
class: processor
stability:
beta: [logs, metrics, traces]
distributions: [contrib]
distributions: [contrib, splunk]
3 changes: 2 additions & 1 deletion processor/logstransformprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
|--------------------------|---------------|
| Stability | [development] |
| Supported pipeline types | logs |
| Distributions | none |
| Distributions | [splunk] |

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 @@ -30,3 +30,4 @@ Refer to [config.yaml](./testdata/config.yaml) for detailed
examples on using the processor.

[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[splunk]: https://github.com/signalfx/splunk-otel-collector
Loading

0 comments on commit 60f5708

Please sign in to comment.