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
30 changes: 30 additions & 0 deletions docs/manuals/spaces/howtos/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,33 @@ spec:
logs: [datadog]
```

<!-- vale Upbound.Spelling = NO -->
<!-- vale Microsoft.HeadingAcronyms = NO -->
#### Splunk HEC Example
<!-- vale Microsoft.HeadingAcronyms = YES -->
<!-- vale Upbound.Spelling = YES -->

```yaml
apiVersion: observability.spaces.upbound.io/v1alpha1
kind: SharedTelemetryConfig
metadata:
name: splunk
namespace: default
spec:
controlPlaneSelector:
labelSelectors:
- matchLabels:
org: foo
exporters:
splunk_hec:
endpoint: https://splunk.example.com:8088/services/collector
token: ${SPLUNK_HEC_TOKEN}
exportPipeline:
metrics: [splunk_hec]
traces: [splunk_hec]
logs: [splunk_hec]
```

### Control plane selection

Use `spec.controlPlaneSelector` to specify which control planes should use the
Expand Down Expand Up @@ -348,6 +375,9 @@ kubectl describe stc <name>
Both Space-level and control plane observability support:
- `datadog` - For Datadog integration
- `otlphttp` - General-purpose exporter (used by New Relic, among others)
<!-- vale Upbound.Spelling = NO -->
- `splunk_hec` - For Splunk HTTP Event Collector integration
<!-- vale Upbound.Spelling = YES -->
- `debug` - For troubleshooting

## Considerations
Expand Down
20 changes: 18 additions & 2 deletions docs/manuals/spaces/howtos/self-hosted/space-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,14 @@ due to breaking changes in the OpenTelemetry Operator.

## Configuration

To configure how Upbound exports, review the `spacesCollector` value in your Space installation Helm chart. Below is an example of an `otlphttp` compatible endpoint.
To configure how Upbound exports telemetry, review the `spacesCollector` value in
Comment thread
cbuto marked this conversation as resolved.
your Space installation Helm chart. Supported exporters are `otlphttp`, `datadog`,
`splunk_hec`, and `debug`. Replace the exporter name and configuration options
based on your backend.

<!-- vale Upbound.Spelling = NO -->
Below is an example using `otlphttp`.
<!-- vale Upbound.Spelling = YES -->

<!-- vale gitlab.MeaningfulLinkWords = NO -->
```yaml
Expand Down Expand Up @@ -65,6 +72,12 @@ observability:
```
<!-- vale gitlab.MeaningfulLinkWords = YES -->

<!-- vale Upbound.Spelling = NO -->
For exporter-specific configuration options, see the OpenTelemetry documentation
for [`otlphttp`][otlphttp-exporter], [`datadog`][datadog-exporter], and
[`splunk_hec`][splunk-exporter].
<!-- vale Upbound.Spelling = YES -->

You can export metrics, logs, and traces from your Crossplane installation, Spaces
infrastructure (controller, API, router, etc.), provider-helm, and
provider-kubernetes.
Expand Down Expand Up @@ -214,7 +227,7 @@ For detailed router metrics documentation and more query examples, see the [Rout

Control plane (`SharedTelemetry`) and Space observability deploy the same custom
OpenTelemetry Collector image. The OpenTelemetry Collector image supports
`otlhttp`, `datadog`, and `debug` exporters.
`otlphttp`, `datadog`, `splunk_hec`, and `debug` exporters.

For more information on observability configuration, review the [Helm chart reference][helm-chart-reference].

Expand Down Expand Up @@ -302,3 +315,6 @@ lifecycle including status codes and client-perceived latency.
[opentelemetry-collector]: https://opentelemetry.io/docs/collector/
[opentelemetry-operator]: https://opentelemetry.io/docs/kubernetes/operator/
[helm-chart-reference]: /reference/spaces-helm-reference/
[otlphttp-exporter]: https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlphttpexporter
[datadog-exporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/datadogexporter
[splunk-exporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/splunkhecexporter