For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/byoc-logs/quickstart.md. A documentation index is available at /llms.txt.

BYOC Logs Quickstart

Join the Preview!

BYOC Logs is in Preview.

Overview

Get started with BYOC Logs locally in less than 5 minutes. This quickstart covers the following:

  1. Start BYOC Logs locally using Docker.
  2. Verify the cluster status.
  3. Send a “Hello World” log.
  4. View the log in the Datadog Log Explorer.

Prerequisites

Step 1: Start BYOC Logs

Run the following command in your terminal to start a local BYOC Logs instance. Replace <YOUR_API_KEY> with your actual Datadog API Key.

export DD_API_KEY="<YOUR_API_KEY>"
export DD_SITE="datadoghq.com"

docker run -d \
  --name byoc-logs \
  -v $(pwd)/qwdata:/quickwit/qwdata \
  -e DD_SITE=${DD_SITE} \
  -e DD_API_KEY=${DD_API_KEY} \
  -p 127.0.0.1:7280:7280 \
  datadog/cloudprem run

Step 2: Verify status in the BYOC Logs console

In Datadog, go to the BYOC Logs console and check that your cluster is connected. You should see the connected status.

In the BYOC Logs console, you can edit the cluster metadata and rename your cluster to demo.

Screenshot of the BYOC Logs console showing the cluster connected status

Step 3: Send a log

In your terminal, send a “Hello World” log entry directly to your local BYOC Logs instance using the API:

curl -X POST "http://localhost:7280/api/v2/logs" \
  -H "Content-Type: application/json" \
  -H "DD-API-KEY: ${DD_API_KEY}" \
  -d '[
    {
      "message": "Hello world from BYOC Logs",
      "level": "info",
      "service": "demo"
    }
  ]'

Step 4: Explore logs

  1. Go to the Datadog Log Explorer.
  2. On the left facet panel, select the checkbox for your index under BYOC INDEXES.
  3. You should see your “Hello world from BYOC Logs” log entry.
The BYOC Logs index selection in the Datadog Log Explorer

Next steps

With BYOC Logs running, you can: