Skip to content

Commit

Permalink
[chore] add Sumo Logic distribution (open-telemetry#22073)
Browse files Browse the repository at this point in the history
Adds Sumo Logic distribution to component docs.
  • Loading branch information
andrzej-stencel committed May 18, 2023
1 parent ef07a3c commit cd82096
Show file tree
Hide file tree
Showing 223 changed files with 500 additions and 376 deletions.
3 changes: 2 additions & 1 deletion cmd/mdatagen/statusdata.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ import (
var distros = map[string]string{
"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",
"aws": "https://github.com/aws-observability/aws-otel-collector",
"observiq": "https://github.com/observIQ/observiq-otel-collector",
"splunk": "https://github.com/signalfx/splunk-otel-collector",
"sumo": "https://github.com/SumoLogic/sumologic-otel-collector",
}

type Status struct {
Expand Down
17 changes: 9 additions & 8 deletions connector/countconnector/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Count Connector

| Status | |
|------------------------- |---------------------------------------------------------- |
| ------------------------ | --------------------------------------------------------- |
| Stability | [in development] |
| Supported pipeline types | See [Supported Pipeline Types](#supported-pipeline-types) |
| Distributions | [] |
| Distributions | [contrib], [sumo] |

The `count` connector can be used to count spans, span events, metrics, data points, and log records.

Expand All @@ -26,7 +26,7 @@ The `count` connector may be used without any configuration settings. The follow
default behavior of the connector.

| [Exporter Pipeline Type] | Description | Default Metric Names |
| ------------------------ | ------------------------------------| -------------------------------------------- |
| ------------------------ | ----------------------------------- | -------------------------------------------- |
| traces | Counts all spans and span events. | `trace.span.count`, `trace.span.event.count` |
| metrics | Counts all metrics and data points. | `metric.count`, `metric.data_point.count` |
| logs | Counts all log records. | `log.record.count` |
Expand Down Expand Up @@ -268,8 +268,9 @@ service:
exporters: [bar/counts_only]
```

[in development]:https://github.com/open-telemetry/opentelemetry-collector#in-development
[Connectors README]:https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md
[Exporter Pipeline Type]:https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md#exporter-pipeline-type
[Receiver Pipeline Type]:https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md#receiver-pipeline-type
[OTTL Syntax]:https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/README.md
[in development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
[Connectors README]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md
[Exporter Pipeline Type]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md#exporter-pipeline-type
[Receiver Pipeline Type]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md#receiver-pipeline-type
6 changes: 4 additions & 2 deletions connector/servicegraphconnector/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Service Graph Connector

| Status | |
|------------------------- |-----------------------------------------------------------|
| ------------------------ | --------------------------------------------------------- |
| Stability | [alpha] |
| Supported pipeline types | See [Supported Pipeline Types](#supported-pipeline-types) |
| Distributions | [contrib] |
| Distributions | [contrib], [sumo] |

## Supported Pipeline Types

Expand Down Expand Up @@ -139,3 +139,5 @@ service:
```

[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
18 changes: 10 additions & 8 deletions connector/spanmetricsconnector/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Span Metrics Connector

| Status | |
|------------------------- |------------------------------------------------------------|
| Stability | [alpha] |
| Supported pipeline types | See [Supported Pipeline Types](#supported-pipeline-types) |
| Distributions | [contrib] |
| Status | |
| ------------------------ | --------------------------------------------------------- |
| Stability | [alpha] |
| Supported pipeline types | See [Supported Pipeline Types](#supported-pipeline-types) |
| Distributions | [contrib], [sumo] |

## Supported Pipeline Types

Expand Down Expand Up @@ -180,6 +180,8 @@ calls_total{span_name="/Address", service_name="shippingservice", span_kind="SPA
For more example configuration covering various other use cases, please visit the [testdata directory](../../connector/spanmetricsconnector/testdata).

[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
[Connectors README]:https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md
[Exporter Pipeline Type]:https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md#exporter-pipeline-type
[Receiver Pipeline Type]:https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md#receiver-pipeline-type
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
[Connectors README]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md
[Exporter Pipeline Type]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md#exporter-pipeline-type
[Receiver Pipeline Type]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/README.md#receiver-pipeline-type
15 changes: 8 additions & 7 deletions exporter/carbonexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Carbon Exporter

| Status | |
| ------------------------ |-----------------------|
| Stability | [beta] |
| Supported pipeline types | metrics |
| Distributions | [contrib], [observiq] |
| Status | |
| ------------------------ | ----------------------------- |
| Stability | [beta] |
| Supported pipeline types | metrics |
| Distributions | [contrib], [observiq], [sumo] |

The [Carbon](https://github.com/graphite-project/carbon) exporter supports
Carbon's [plaintext
Expand Down Expand Up @@ -38,6 +38,7 @@ exporters:
The full list of settings exposed for this receiver are documented [here](./config.go)
with detailed sample configurations [here](./testdata/config.yaml).

[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[observiq]: https://github.com/observIQ/observiq-otel-collector
[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
2 changes: 1 addition & 1 deletion exporter/f5cloudexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| ------------------------ |-----------------------|
| Stability | [beta] |
| Supported pipeline types | traces, logs, metrics |
| Distributions | [contrib, observiq] |
| Distributions | [contrib], [observiq] |

Exports data via HTTP to [F5 Cloud](https://portal.cloudservices.f5.com/).

Expand Down
17 changes: 9 additions & 8 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], [splunk], [observiq] |
| Status | |
| ------------------------ | ----------------------------------------------- |
| Stability | [alpha] |
| Supported pipeline types | traces, metrics, logs |
| Distributions | [core], [contrib], [observiq], [splunk], [sumo] |

Exporter supports the following features:

Expand Down Expand Up @@ -132,8 +132,9 @@ spec:
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
[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
[observiq]: https://github.com/observIQ/observiq-otel-collector
[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
15 changes: 8 additions & 7 deletions exporter/kafkaexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Kafka Exporter

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

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 @@ -88,7 +88,8 @@ exporters:
protocol_version: 2.0.0
```

[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[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
[observiq]: https://github.com/observIQ/observiq-otel-collector
[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
15 changes: 8 additions & 7 deletions exporter/loadbalancingexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Trace ID/Service-name aware load-balancing exporter

| Status | |
| ------------------------ |-----------------------|
| Stability | [beta] |
| Supported pipeline types | traces, logs |
| Distributions | [contrib], [observiq] |
| Status | |
| ------------------------ | ----------------------------- |
| Stability | [beta] |
| Supported pipeline types | traces, logs |
| Distributions | [contrib], [observiq], [sumo] |

This is an exporter that will consistently export spans and logs depending on the `routing_key` configured. If no `routing_key` is configured, the default routing mechanism is `traceID`. This means that spans belonging to the same `traceID` (or `service.name`, when `service` is used as the `routing_key`) will be sent to the same backend.

Expand Down Expand Up @@ -199,6 +199,7 @@ The following metrics are recorded by this processor:
* `otelcol_loadbalancer_backend_outcome` counts what the outcomes were for each endpoint, `success=true|false`.


[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
[observiq]: https://github.com/observIQ/observiq-otel-collector
[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
17 changes: 9 additions & 8 deletions exporter/prometheusexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Prometheus Exporter

| Status | |
| ------------------------ |-------------------------------|
| Stability | [beta] |
| Supported pipeline types | metrics |
| Distributions | [core], [contrib], [observiq] |
| Status | |
| ------------------------ | ------------------------------------- |
| Stability | [beta] |
| Supported pipeline types | metrics |
| Distributions | [core], [contrib], [observiq], [sumo] |

Exports data in the [Prometheus format](https://prometheus.io/docs/concepts/data_model/), which allows it to be scraped by a [Prometheus](https://prometheus.io/) server.

Expand Down Expand Up @@ -51,7 +51,8 @@ Given the example, metrics will be available at `https://1.2.3.4:1234/metrics`.

OpenTelemetry metric names and attributes are normalized to be compliant with Prometheus naming rules. [Details on this normalization process are described in the Prometheus translator module](../../pkg/translator/prometheus/).

[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
[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
[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[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
[observiq]: https://github.com/observIQ/observiq-otel-collector
[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
3 changes: 2 additions & 1 deletion extension/asapauthextension/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], [sumo] |

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

This extension provides [Atlassian Service Authentication Protocol](https://s2sauth.bitbucket.io/) (ASAP) client
Expand Down
2 changes: 1 addition & 1 deletion extension/asapauthextension/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, sumo]
3 changes: 2 additions & 1 deletion extension/awsproxy/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], [sumo] |

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


Expand Down
2 changes: 1 addition & 1 deletion extension/awsproxy/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, sumo]
3 changes: 2 additions & 1 deletion extension/basicauthextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
| Status | |
| ------------- |-----------|
| Stability | [beta] |
| Distributions | [contrib], [observiq] |
| Distributions | [contrib], [observiq], [sumo] |

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

This extension implements both `configauth.ServerAuthenticator` and `configauth.ClientAuthenticator` to authenticate clients and servers using Basic Authentication. The authenticator type has to be set to `basicauth`.
Expand Down
2 changes: 1 addition & 1 deletion extension/basicauthextension/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, observiq]
distributions: [contrib, observiq, sumo]
3 changes: 2 additions & 1 deletion extension/bearertokenauthextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
| Status | |
| ------------- |-----------|
| Stability | [beta] |
| Distributions | [contrib], [observiq] |
| Distributions | [contrib], [observiq], [sumo] |

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


Expand Down
2 changes: 1 addition & 1 deletion extension/bearertokenauthextension/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, observiq]
distributions: [contrib, observiq, sumo]
3 changes: 2 additions & 1 deletion extension/headerssetterextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
| Status | |
| ------------- |-----------|
| Stability | [alpha] |
| Distributions | [contrib] |
| Distributions | [contrib], [sumo] |

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

The `headers_setter` extension implements `ClientAuthenticator` and is used to
Expand Down
2 changes: 1 addition & 1 deletion extension/headerssetterextension/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, sumo]
3 changes: 2 additions & 1 deletion extension/healthcheckextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
| Status | |
| ------------- |-----------|
| Stability | [beta] |
| Distributions | [core], [contrib], [observiq], [splunk] |
| Distributions | [core], [contrib], [observiq], [splunk], [sumo] |

[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
[observiq]: https://github.com/observIQ/observiq-otel-collector
[splunk]: https://github.com/signalfx/splunk-otel-collector
[sumo]: https://github.com/SumoLogic/sumologic-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, splunk, observiq]
distributions: [core, contrib, splunk, observiq, sumo]
Loading

0 comments on commit cd82096

Please sign in to comment.