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

docs: Add loki and datadog documentation #2159

Merged
merged 1 commit into from
Jul 31, 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
24 changes: 24 additions & 0 deletions docs/docs.logflare.com/docs/backends/datadog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_position: 5
---

# Datadog

The Datadog backend is **ingest-only**, and sends events to the Datadog HTTP API.

See the Datadog HTTP API [documentation](https://docs.datadoghq.com/api/latest/logs/#send-logs) for details on how the API handles events.

## Behaviour and configurations

### Configuration

The following values are required when creating a webhook backend:

- `api_key`: (`string`, required) a API Key generated from the Datadog dashboard, specific for that region.
- `region`: (`string`, required) specific region API to send the events to. Corresponds to the [Datadog sites](https://docs.datadoghq.com/getting_started/site/) (for example `US5`)

### Implementation Details

Implementation is based on the [webhook backend](/backends/webhook).

Events will be gzipped and batch with a maximum of 250 events per request. The source name will be set as the service name.
26 changes: 26 additions & 0 deletions docs/docs.logflare.com/docs/backends/loki.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
sidebar_position: 6
---

# Loki

The Loki backend is **ingest-only**, and sends events to a Loki HTTP API.

See the Loki HTTP API [documentation](https://grafana.com/docs/loki/latest/reference/loki-http-api/#ingest-logs) for details on how the API handles events.

## Behaviour and configurations

### Configuration

The following values are required when creating a webhook backend:

- `url`: (`string`, required) the HTTP url to send the events to.
- `headers`: (`map`, optional) the headers to be attached to the HTTP request, for authentication purposes.

### Implementation Details

Implementation is based on the [webhook backend](/backends/webhook).

Events will be gzipped as a JSON payload, and will be batched with a maximum of 250 events per request.

The source name will be used as the stream label.
Loading