From 37eae199f5506ff4f66001934e6d90f3be040594 Mon Sep 17 00:00:00 2001 From: TzeYiing Date: Tue, 30 Jul 2024 15:07:53 +0800 Subject: [PATCH] docs: Add loki and datadog documentation --- .../docs/backends/datadog.mdx | 24 +++++++++++++++++ docs/docs.logflare.com/docs/backends/loki.mdx | 26 +++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 docs/docs.logflare.com/docs/backends/datadog.mdx create mode 100644 docs/docs.logflare.com/docs/backends/loki.mdx diff --git a/docs/docs.logflare.com/docs/backends/datadog.mdx b/docs/docs.logflare.com/docs/backends/datadog.mdx new file mode 100644 index 000000000..968f485ab --- /dev/null +++ b/docs/docs.logflare.com/docs/backends/datadog.mdx @@ -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. diff --git a/docs/docs.logflare.com/docs/backends/loki.mdx b/docs/docs.logflare.com/docs/backends/loki.mdx new file mode 100644 index 000000000..a92ae8320 --- /dev/null +++ b/docs/docs.logflare.com/docs/backends/loki.mdx @@ -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.