Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GEN-1947]: add Better Stack destination support and documentation #2083

Merged
merged 11 commits into from
Dec 29, 2024
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ For more details, see our [quickstart guide](https://docs.odigos.io/intro).
| Axiom | ✅ | | ✅ |
| AWS S3 | ✅ | | ✅ |
| Azure Blob Storage | ✅ | | ✅ |
| Better Stack | | ✅ | ✅ |
| Causely | ✅ | | |
| Chronosphere | ✅ | ✅ | |
| Coralogix | ✅ | ✅ | ✅ |
Expand Down
54 changes: 54 additions & 0 deletions common/config/betterstack.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package config

import (
"github.com/odigos-io/odigos/common"
)

type BetterStack struct{}

func (j *BetterStack) DestType() common.DestinationType {
return common.BetterStackDestinationType
}

func (j *BetterStack) ModifyConfig(dest ExporterConfigurer, cfg *Config) error {
uniqueUri := "betterstack-" + dest.GetID()

processorName := "attributes/" + uniqueUri
cfg.Processors[processorName] = GenericMap{
"actions": []GenericMap{
{
"key": "better_stack_source_token",
"value": "${BETTERSTACK_TOKEN}",
"action": "insert",
},
},
}

if isMetricsEnabled(dest) {
exporterName := "prometheusremotewrite/" + uniqueUri
BenElferink marked this conversation as resolved.
Show resolved Hide resolved
cfg.Exporters[exporterName] = GenericMap{
"endpoint": "https://in-otel.logs.betterstack.com/metrics",
}

pipeName := "metrics/" + uniqueUri
cfg.Service.Pipelines[pipeName] = Pipeline{
Processors: []string{processorName},
Exporters: []string{exporterName},
}
}

if isLoggingEnabled(dest) {
exporterName := "otlp/" + uniqueUri
cfg.Exporters[exporterName] = GenericMap{
"endpoint": "https://in-otel.logs.betterstack.com:443",
}

pipeName := "logs/" + uniqueUri
cfg.Service.Pipelines[pipeName] = Pipeline{
Processors: []string{processorName},
Exporters: []string{exporterName},
}
}

return nil
}
2 changes: 1 addition & 1 deletion common/config/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const (
)

var availableConfigers = []Configer{
&AppDynamics{}, &Axiom{}, &AWSS3{}, &AzureBlobStorage{}, &Causely{}, &Chronosphere{}, &Clickhouse{}, &Coralogix{},
&AppDynamics{}, &Axiom{}, &AWSS3{}, &AzureBlobStorage{}, &BetterStack{}, &Causely{}, &Chronosphere{}, &Clickhouse{}, &Coralogix{},
&Datadog{}, &Debug{}, &Dynatrace{}, &ElasticAPM{}, &Elasticsearch{}, &GenericOTLP{}, &GoogleCloud{},
&GoogleCloudStorage{}, &GrafanaCloudLoki{}, &GrafanaCloudPrometheus{}, &GrafanaCloudTempo{}, &Groundcover{},
&Honeycomb{}, &Jaeger{}, &Last9{}, &Lightstep{}, &Logzio{}, &Loki{}, &Lumigo{}, &Middleware{}, &Mock{}, &NewRelic{},
Expand Down
1 change: 1 addition & 0 deletions common/dests.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const (
AWSS3DestinationType DestinationType = "s3"
AxiomDestinationType DestinationType = "axiom"
AzureBlobDestinationType DestinationType = "azureblob"
BetterStackDestinationType DestinationType = "betterstack"
CauselyDestinationType DestinationType = "causely"
ChronosphereDestinationType DestinationType = "chronosphere"
ClickhouseDestinationType DestinationType = "clickhouse"
Expand Down
23 changes: 23 additions & 0 deletions destinations/data/betterstack.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
apiVersion: internal.odigos.io/v1beta1
kind: Destination
metadata:
type: betterstack
displayName: Better Stack
category: managed
spec:
image: betterstack.svg
signals:
traces:
supported: false
metrics:
supported: true
logs:
supported: true
fields:
- name: BETTERSTACK_TOKEN
displayName: Better Stack Source Token
componentType: input
secret: true
componentProps:
type: password
required: true
8 changes: 8 additions & 0 deletions destinations/logos/betterstack.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/backends-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Odigos has destinations for many observability backends.
| Axiom | Managed | ✅ | | ✅ |
| AWS S3 | Managed | ✅ | | ✅ |
| Azure Blob Storage | Managed | ✅ | | ✅ |
| Better Stack | Managed | | ✅ | ✅ |
| Causely | Managed | ✅ | | |
| Chronosphere | Managed | ✅ | ✅ | |
| ClickHouse | Self-Hosted | ✅ | ✅ | ✅ |
Expand Down
60 changes: 60 additions & 0 deletions docs/backends/betterstack.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: 'Better Stack'
---

## Configuring Backend

- **BETTERSTACK_TOKEN** - Source Token, generated from Better Stack UI.

**Note:**
We handle the endpoint internally, so you don't need to provide it.
- The endpoint for metrics is `https://in-otel.logs.betterstack.com/metrics`.
- The endpoint for logs is `https://in-otel.logs.betterstack.com:443`.

## Adding a Destination to Odigos

Odigos makes it simple to add and configure destinations, allowing you to select the specific signals [traces/logs/metrics] that you want to send to each destination. There are two primary methods for configuring destinations in Odigos:

1. **Using the UI**

Use the [Odigos CLI](https://docs.odigos.io/cli/odigos_ui) to access the UI:

```bash
odigos ui
```

2. **Using kubernetes manifests**

Save the YAML below to a file (e.g., `destination.yaml`) and apply it using `kubectl`:

```bash
kubectl apply -f destination.yaml
```


```yaml
apiVersion: odigos.io/v1alpha1
kind: Destination
metadata:
name: betterstack-example
namespace: odigos-system
spec:
data: {}
destinationName: betterstack
secretRef:
name: betterstack-secret
signals:
- METRICS
- LOGS
type: betterstack

---
apiVersion: v1
data:
BETTERSTACK_TOKEN: <base64 Better Stack Source Token>
kind: Secret
metadata:
name: betterstack-secret
namespace: odigos-system
type: Opaque
```
1 change: 1 addition & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@
"backends/s3",
"backends/axiom",
"backends/azureblob",
"backends/betterstack",
"backends/causely",
"backends/chronosphere",
"backends/clickhouse",
Expand Down
1 change: 1 addition & 0 deletions docs/quickstart/next-steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Select the relevant backend for your use case below to connect it to Odigos.
<Card title="AWS S3" href="/backends/s3" />
<Card title="Axiom" href="/backends/axiom" />
<Card title="Azure Blob Storage" href="/backends/azureblob" />
<Card title="Better Stack" href="/backends/betterstack" />
<Card title="Causely" href="/backends/causely" />
<Card title="Chronosphere" href="/backends/chronosphere" />
<Card title="Coralogix" href="/backends/coralogix" />
Expand Down
Loading