Better Stack Documentation

https://betterstack.com/docs
Admin
Better Stack provides comprehensive documentation for its observability platform, covering uptime...
Tokens:754,891
Snippets:6,241
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Set up Vector with setup script (Linux/macOS)

Source: https://betterstack.com/docs/logs/docker

Runs the Better Stack setup script for Docker, which installs Vector, configures it for your source, and enables/restarts the service. The script asks for confirmation before making changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/docker/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Set up Vector on Linux (setup script)

Source: https://betterstack.com/docs/logs/mysql

Installs and configures Vector for MySQL metrics on Linux using the Better Stack setup script. The script installs Vector, configures it for your source, and enables/restarts it after confirmation.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/mysql_with_metrics/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Set up Vector on Linux (setup script)

Source: https://betterstack.com/docs/logs/elasticsearch

Downloads and runs the Better Stack setup script for Vector on supported Linux platforms. The script installs Vector, configures it for your source, and enables/restarts the service, asking for confirmation before making changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/elasticsearch_with_metrics/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Install RSyslog TLS package (quick start)

Source: https://betterstack.com/docs/logs/rsyslog-setup

Installs the RSyslog TLS package needed for the quick-start setup on Debian/Ubuntu systems.

```bash
apt-get install rsyslog-gnutls
```

--------------------------------

### Set up Vector for MongoDB with setup script

Source: https://betterstack.com/docs/logs/mongodb

One-command setup for Vector on Ubuntu/Debian (and other platforms with the setup script). Installs Vector, configures it for your Better Stack MongoDB source, and enables/restarts the service. The script asks for confirmation before making changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/mongodb/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Install and start elasticsearch exporter

Source: https://betterstack.com/docs/logs/elasticsearch

Installs and starts the latest elasticsearch exporter using the Better Stack installation script.

```bash
curl -sSL https://telemetry.betterstack.com/install/elasticsearch_exporter | sudo -E bash
```

--------------------------------

### Set up Vector with setup script (Linux, macOS, supported)

Source: https://betterstack.com/docs/logs/haproxy

Runs the Better Stack setup script for HAProxy, which installs Vector, configures it for your source, and enables/restarts the service. The script asks for confirmation before making changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/haproxy/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Install, configure, and run Vector on Windows

Source: https://betterstack.com/docs/logs/traefik

Installs Vector on Windows using the official MSI installer, downloads the Vector configuration for your source (backing up the existing config), and starts Vector with the new configuration.

```powershell
powershell Invoke-WebRequest https://packages.timber.io/vector/latest/vector-x64.msi -OutFile vector-latest-x64.msi
msiexec /i vector-latest-x64.msi
```

```powershell
$config_yaml_path = "C:\Program Files\Vector\config\vector.yaml"
$backup_path = "C:\Program Files\Vector\config\vector-backup.yaml"
Move-Item -Path "$config_yaml_path" -Destination "$backup_path"
Invoke-RestMethod -Uri https://telemetry.betterstack.com/vector-yaml/traefik_with_metrics/$SOURCE_TOKEN |
  Add-Content $config_yaml_path
```

```powershell
& "C:\Program Files\Vector\bin\vector" --config "C:\Program Files\Vector\config\vector.yaml"
```

--------------------------------

### Quick-start RSyslog setup script (TCP recommended, UDP)

Source: https://betterstack.com/docs/logs/rsyslog-setup

Quick-start setup scripts for sending logs via TCP (recommended) or UDP. The script detects if rsyslog is installed and creates configuration for your Better Stack source.

```bash
wget -qO- https://telemetry.betterstack.com/rsyslog/$SOURCE_TOKEN | sh
```

```bash
wget -qO- https://telemetry.betterstack.com/rsyslog/udp/$SOURCE_TOKEN | sh
```

--------------------------------

### Install samber/slog-betterstack

Source: https://betterstack.com/docs/logs/go

Install the samber/slog-betterstack package using go get.

```bash
go get github.com/samber/slog-betterstack
```

--------------------------------

### Set up Vector (Linux apt, yum, macOS, setup-script-supported)

Source: https://betterstack.com/docs/logs/rabbitmq

Install and configure Vector on Ubuntu/Debian, Red Hat-based Linux, macOS, or via the setup script. The script installs Vector, configures it for your Better Stack source, and enables/restarts Vector, asking for confirmation before changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/rabbitmq_with_metrics/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Install and configure Vector on Ubuntu/Debian

Source: https://betterstack.com/docs/logs/log-forwarding

Downloads and runs the Better Stack setup script for Vector on Ubuntu or Debian. Replace $SOURCE_TOKEN with your source token. The script installs Vector, configures it for your source, and enables/restarts the service, asking for confirmation before making changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/ubuntu/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh

```

--------------------------------

### Set up Vector with setup script

Source: https://betterstack.com/docs/logs/redis

Set up Vector on Ubuntu, Debian, Red Hat-based Linux, or macOS using the Better Stack setup script. The script installs Vector, configures it for your source, and enables/restarts Vector; it will ask for confirmation before making changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/redis_with_metrics/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Set up Vector with Better Stack setup script

Source: https://betterstack.com/docs/logs/minio

Downloads and runs the Better Stack setup script for Vector on supported platforms. The script installs Vector, configures it for your Better Stack source, and enables/restarts Vector after confirmation.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/minio/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Initialize data collection with betterstack('init', opts)

Source: https://betterstack.com/docs/errors/js-tag/install

Starts data collection. Options include environment, release, autoPageview, and debug. The example sets environment to 'production' and release to '1.4.2'.

```javascript
betterstack('init', {
  environment: 'production',
  release: '1.4.2',
});
```

--------------------------------

### Install and configure Vector on Ubuntu/Debian

Source: https://betterstack.com/docs/logs/ingesting-data/logs/docker-kubernetes

Downloads and runs the Better Stack setup script for Docker on Ubuntu or Debian. Replace $SOURCE_TOKEN with your source token. The script installs Vector, configures it for your Better Stack source, and enables/restarts Vector after asking for confirmation.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/docker/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh

```

--------------------------------

### Install RSyslog TLS package (manual setup)

Source: https://betterstack.com/docs/logs/rsyslog-setup

Installs the RSyslog TLS package for the manual setup on Debian/Ubuntu systems.

```bash
apt install rsyslog-gnutls
```

--------------------------------

### Install OpenTelemetry collector

Source: https://betterstack.com/docs/logs/open-telemetry

Installs the latest OpenTelemetry collector on your system. Run this as the first step to start collecting telemetry data.

```bash
curl -sSL https://telemetry.betterstack.com/install/otelcol-contrib | sudo -E bash
```

--------------------------------

### Install, configure, and run Vector on Linux (manual)

Source: https://betterstack.com/docs/logs/traefik

Installs Vector using the official installer, creates a systemd service, downloads the Vector configuration for your source (backing up the existing config), and restarts Vector to reload the configuration.

```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.vector.dev | sh -s -- -y
```

```sh
mkdir -p /etc/vector
mkdir -p /var/lib/vector/
cat <<-'SERVICE' >> /etc/systemd/system/vector.service
[Unit]
Description=Vector
Documentation=https://vector.dev
After=network-online.target
Requires=network-online.target

[Service]
User=vector
Group=vector
ExecStart=/root/.vector/bin/vector
ExecReload=/bin/kill -HUP $MAINPID
Restart=no
AmbientCapabilities=CAP_NET_BIND_SERVICE
EnvironmentFile=-/etc/default/vector

[Install]
WantedBy=multi-user.target
SERVICE
```

```bash
CONFIG_YAML_PATH="/etc/vector/vector.yaml"
BACKUP_SUFFIX=".bak-$(date +%Y%m%d%H%M%S)"
mv "${CONFIG_YAML_PATH}" "${CONFIG_YAML_PATH}${BACKUP_SUFFIX}"
curl -o "$CONFIG_YAML_PATH" \
  https://telemetry.betterstack.com/vector-yaml/traefik_with_metrics/$SOURCE_TOKEN
```

```sh
systemctl restart vector
```

--------------------------------

### Set up Vector for PostgreSQL with setup script

Source: https://betterstack.com/docs/logs/postgresql

Installs and configures Vector for PostgreSQL on Ubuntu/Debian, Red Hat-based Linux, or macOS. The script installs Vector, configures it for your Better Stack source, and enables/restarts the service, asking for confirmation before making changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/postgresql/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Set up Vector for MySQL on Linux with setup script

Source: https://betterstack.com/docs/logs/mysql

Installs Vector using the official package, configures it for your Better Stack source, and enables and restarts Vector. The script will ask for confirmation before making any changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/mysql/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Minimal PQL query

Source: https://betterstack.com/docs/logs/dashboards/pql-queries

Starts a PQL query with {{source}} and pipes operators using |. This example takes the first 10 rows.

```sql
{{source}}
  | take 10
```

--------------------------------

### Enable Google Run and SecretsManager APIs

Source: https://betterstack.com/docs/logs/sources/cloud/google-run

Enable the Google Run and SecretsManager APIs before starting the setup.

```bash
gcloud services enable run.googleapis.com secretmanager.googleapis.com
```

--------------------------------

### Sentry SDK integration examples for JavaScript, Python, and Ruby

Source: https://betterstack.com/docs/errors/collecting-errors/ai-prompt

These examples show how to initialize the Sentry SDK and capture an exception in JavaScript, Python, and Ruby. They are provided as reference for what the AI prompt integration produces. Each example uses a placeholder DSN with $APPLICATION_TOKEN, $INGESTING_HOST, and $APPLICATION_ID, and enables performance monitoring via tracesSampleRate or traces_sample_rate.

```javascript
import * as Sentry from "@sentry/browser";

Sentry.init({
  dsn: "https://$APPLICATION_TOKEN@$INGESTING_HOST/$APPLICATION_ID",
  // To capture performance monitoring data,
  // you must set tracesSampleRate
  tracesSampleRate: 1.0,
});

// Example of capturing an exception
try {
  throw new Error("This is a test error from the browser!");
} catch (e) {
  Sentry.captureException(e);
}
```

```python
import sentry_sdk

sentry_sdk.init(
    dsn="https://$APPLICATION_TOKEN@$INGESTING_HOST/$APPLICATION_ID",
    # Set traces_sample_rate to 1.0 to capture 100%
    # of transactions for performance monitoring.
    traces_sample_rate=1.0,
)

# Example of capturing an exception
try:
    1 / 0
except ZeroDivisionError as e:
    sentry_sdk.capture_exception(e)
```

```ruby
require 'sentry-ruby'

Sentry.init do |config|
  config.dsn = 'https://$APPLICATION_TOKEN@$INGESTING_HOST/$APPLICATION_ID'
  config.breadcrumbs_logger = [:active_support_logger, :http_logger]

  # To activate performance monitoring, set one of these options.
  # We recommend adjusting the value in production:
  config.traces_sample_rate = 1.0
end

# Example of capturing an exception
begin
  1 / 0
rescue ZeroDivisionError => exception
  Sentry.capture_exception(exception)
end
```

--------------------------------

### Example runbook instructions with TODO list

Source: https://betterstack.com/docs/uptime/runbooks

Markdown-formatted runbook instructions with a TODO list. Use this as a template for creating runbook steps in the Instructions & todo list step of an escalation policy. Start lines with '- [ ]' to add interactive tasks.

```markdown
## When to Use
Triggered when CPU > 90% for 5+ minutes on a web server.

## Steps
- [ ] **Acknowledge the Alert**
- [ ] **Find the Affected Server**
   - Use logs or metrics dashboard to identify the instance/container
   - Example: `aws ecs list-tasks --cluster web-prod`
- [ ] **SSH or Access Container**
   - `ssh ec2-user@<instance-ip>`
- [ ] **Diagnose the Issue**
   - Run `top` or `htop` to find CPU-heavy process
   - Check application logs
- [ ] **Fix or Mitigate**
   - Restart service if needed
   - Scale up if traffic is legitimate
- [ ] **Verify**
   - CPU drops below 70%
   - No 5xx errors
   - App is responsive
```

--------------------------------

### Enable Vector log collection and download config

Source: https://betterstack.com/docs/logs/dokku

Two-step setup for Better Stack logging on Dokku: first start the Vector log collection with the specified image, then download the Vector configuration using your source token.

```bash
dokku logs:vector-start \
    --vector-image timberio/vector:latest-debian
```

```bash
curl -o /var/lib/dokku/data/logs/vector.json \
    https://telemetry.betterstack.com/vector-json/dokku/$SOURCE_TOKEN
```

--------------------------------

### Install @logtail/next

Source: https://betterstack.com/docs/logs/javascript/nextjs

Installs the Logtail Next.js NPM package. Run this in your project directory before setting up the client.

```bash
npm install @logtail/next
```

--------------------------------

### Set up Vector with Better Stack script

Source: https://betterstack.com/docs/logs/rabbitmq

Runs the Better Stack setup script for Vector on supported Linux platforms. The script installs Vector, configures it for the RabbitMQ source, and enables/restarts the service, asking for confirmation before making changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/rabbitmq/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Start Vector on Windows

Source: https://betterstack.com/docs/logs/apache

Start Vector with the new configuration on Windows.

```powershell
& "C:\Program Files\Vector\bin\vector" --config "C:\Program Files\Vector\config\vector.yaml"
```

--------------------------------

### Example htpasswd file (/etc/squid/passwords)

Source: https://betterstack.com/docs/uptime/monitoring-private-networks

Example contents of the passwords file. Replace the placeholder with the actual output from the htpasswd generation command.

```text
[label /etc/squid/passwords]
user1:$2y$10$...................................................
```

--------------------------------

### Install Vector and create service on Linux

Source: https://betterstack.com/docs/logs/redis

Install Vector on other Linux distributions using the official installer and create a systemd service for it.

```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.vector.dev | sh -s -- -y
```

```sh
mkdir -p /etc/vector
mkdir -p /var/lib/vector/
cat <<-'SERVICE' >> /etc/systemd/system/vector.service
[Unit]
Description=Vector
Documentation=https://vector.dev
After=network-online.target
Requires=network-online.target

[Service]
User=vector
Group=vector
ExecStart=/root/.vector/bin/vector
ExecReload=/bin/kill -HUP $MAINPID
Restart=no
AmbientCapabilities=CAP_NET_BIND_SERVICE
EnvironmentFile=-/etc/default/vector

[Install]
WantedBy=multi-user.target
SERVICE
```

--------------------------------

### Setup syslog-ng with Better Stack script (TCP or UDP)

Source: https://betterstack.com/docs/logs/syslog-setup

Use the TCP script for encrypted TCP logging (recommended) or the UDP script for unencrypted UDP logging. The script detects if syslog-ng is installed, creates configuration for your Better Stack source, and downloads Let's Encrypt root certificates without installing them globally.

```bash
wget -qO- https://telemetry.betterstack.com/syslog-ng/$SOURCE_TOKEN | sh
```

```bash
wget -qO- https://telemetry.betterstack.com/syslog-ng/udp/$SOURCE_TOKEN | sh
```

--------------------------------

### List all connections - cURL example

Source: https://betterstack.com/docs/logs/api/connections

Example cURL command to list all connections. Requires a global API token in the Authorization header.

```bash
curl --request GET \
  --url https://telemetry.betterstack.com/api/v1/connections \
  --header "Authorization: Bearer $TOKEN"
```

--------------------------------

### Start mysqld exporter on Linux and macOS

Source: https://betterstack.com/docs/logs/mysql

Starts the mysqld exporter service on Linux using systemctl or on macOS using launchctl.

```sh
systemctl start mysqld_exporter
```

```sh
launchctl start com.prometheus.mysqld_exporter
```

--------------------------------

### Install mysqld exporter

Source: https://betterstack.com/docs/logs/mysql

Downloads and installs the latest mysqld exporter using the Better Stack installation script.

```bash
curl -sSL https://telemetry.betterstack.com/install/mysqld_exporter | sudo -E bash
```

--------------------------------

### Set up Vector for Traefik on Linux

Source: https://betterstack.com/docs/logs/traefik

Runs the Better Stack setup script for Traefik on supported Linux platforms. The script installs Vector, configures it for your Better Stack source, and enables/restarts the service, asking for confirmation before making changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/traefik/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Install Vector on Windows

Source: https://betterstack.com/docs/logs/apache

Install Vector on Windows using the official MSI installer. Run these commands in PowerShell.

```powershell
powershell Invoke-WebRequest https://packages.timber.io/vector/latest/vector-x64.msi -OutFile vector-latest-x64.msi
msiexec /i vector-latest-x64.msi
```

--------------------------------

### Install Better Stack Fluent plugin (fluent-gem install fluent-plugin-logtail)

Source: https://betterstack.com/docs/logs/fluentd

Install the Better Stack Fluent plugin using the Fluentd gem command. This is required to enable the logtail output plugin.

```bash
fluent-gem install fluent-plugin-logtail
```

--------------------------------

### Restart RSyslog service (quick start)

Source: https://betterstack.com/docs/logs/rsyslog-setup

Restarts the RSyslog service to reload the configuration after a quick-start setup. Logs should then appear in Better Stack Live tail.

```bash
systemctl restart rsyslog
```

--------------------------------

### Start postgres exporter on Linux or macOS

Source: https://betterstack.com/docs/logs/postgresql

Starts the PostgreSQL exporter on Linux using systemctl or on macOS using launchctl. These are alternative commands for different platforms.

```sh
systemctl start postgres_exporter
```

```sh
launchctl start com.prometheus.postgres_exporter
```

--------------------------------

### Install postgres exporter

Source: https://betterstack.com/docs/logs/postgresql

Installs the latest postgres exporter using the Better Stack installation script.

```bash
curl -sSL https://telemetry.betterstack.com/install/postgres_exporter | sudo -E bash
```

--------------------------------

### Install Redis exporter

Source: https://betterstack.com/docs/logs/redis

Install the latest Redis exporter using the Better Stack installation script.

```bash
curl -sSL https://telemetry.betterstack.com/install/redis_exporter | sudo -E bash
```

--------------------------------

### Example log entries matching a simple query

Source: https://betterstack.com/docs/logs/using-logtail/live-tail-query-language

Two example log entries that match a simple query for 'Hello'. The first has a message_string field, the second has article_published_at and article_title fields.

```json
{
  message_string: "Hello world!",
}
```

```json
{
  article_published_at: "2021-05-26T13:32:01Z",
  article_title: "The band Hello announced a new tour!"
}
```

--------------------------------

### Install Vector on Ubuntu/Debian via APT

Source: https://betterstack.com/docs/logs/log-forwarding

Configures the Vector APT repository and installs Vector using apt-get. Use this on Debian-based systems.

```bash
bash -c "$(curl -L https://setup.vector.dev)"
apt-get install vector

```

--------------------------------

### Install OpenTelemetry packages

Source: https://betterstack.com/docs/logs/javascript/nextjs

Install the OpenTelemetry packages required to send traces, metrics, and logs from a Next.js app to Better Stack.

```bash
npm install @vercel/otel @opentelemetry/exporter-trace-otlp-http @opentelemetry/exporter-metrics-otlp-http @opentelemetry/exporter-logs-otlp-http @opentelemetry/sdk-trace-node @opentelemetry/sdk-metrics @opentelemetry/sdk-logs
```

--------------------------------

### Pattern detection algorithm example

Source: https://betterstack.com/docs/logs/using-logtail/using-pattern-field

Shows an example of the pattern detection algorithm: the original log message, the extracted pattern, and the resulting MD5 hash.

```text
[label Pattern detection algorithm]
Original: [2019-07-24 12:06:21] package.name [DEBUG] got 10 things in 3.1s
Pattern:  package.name got things in
Hash:     6a7b8c9d1e2f3a4b5c6d7e8f9a0b1c2d
```

--------------------------------

### Install @logtail/browser

Source: https://betterstack.com/docs/logs/javascript/install

Installs the @logtail/browser npm package for browser logging.

```bash
npm install @logtail/browser
```

--------------------------------

### Install @logtail/winston and @logtail/node

Source: https://betterstack.com/docs/logs/javascript/winston

Install the required npm packages for the Better Stack Winston transport.

```bash
npm install @logtail/winston @logtail/node
```

--------------------------------

### List Slack integrations response example

Source: https://betterstack.com/docs/uptime/api/list-all-slack-integrations

Example JSON response for a successful request (status 200). Includes pagination details and integration attributes.

```json
{
  "data": [
    {
      "id": "37",
      "type": "slack_integration",
      "attributes": {
        "slack_team_id": "T04UQ7K4QMB",
        "slack_team_name": "My Slack integration",
        "slack_channel_id": "C07Q2KF20EU",
        "slack_channel_name": "#better-stack-incidents",
        "slack_status": "active",
        "integration_type": "channel",
        "on_call_notifications": true,
        "notify_alongside_primary_responder": true,
        "team_name": "Testing",
        "alert_options": [
          {
            "type": "policy",
            "id": 73,
            "name": "High severity policy",
            "team_id": 7,
            "team_name": "My team"
          },
          {
            "type": "team",
            "id": 7,
            "name": "My team",
            "call": false,
            "sms": false,
            "email": true,
            "push": false
          }
        ]
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/slack-integrations?page=1",
    "last": "https://incidents.betterstack.com/api/v2/slack-integrations?page=1",
    "prev": null,
    "next": null
  }
}
```

--------------------------------

### Install Datadog Agent with Better Stack

Source: https://betterstack.com/docs/logs/datadog-agent

Installs the Datadog Agent using the official install script, configuring it to send metrics to Better Stack. Requires environment variables INGESTING_HOST_DATADOG and SOURCE_TOKEN.

```sh
DD_URL="https://$INGESTING_HOST_DATADOG" \
DD_API_KEY="$SOURCE_TOKEN" \
DD_HOSTNAME="$(hostname)" \
DD_INSTRUMENTATION_TELEMETRY_ENABLED="false" \
bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_agent7.sh)"
```

--------------------------------

### Install @logtail/node

Source: https://betterstack.com/docs/logs/javascript/install

Installs the @logtail/node npm package for Node.js backend logging.

```bash
npm install @logtail/node
```

--------------------------------

### Fulltext search: Match GET or POST requests

Source: https://betterstack.com/docs/logs/using-logtail/live-tail-query-language

Applies the regex to the entire log message, searching across all columns. Matches logs where the message contains 'Started GET' or 'Started POST'.

```regex
/Started (GET|POST)/
```

--------------------------------

### Example curl output

Source: https://betterstack.com/docs/uptime/monitoring-private-networks

Example output from the curl test command, showing the proxy connection and response from example.com.

```text
[output]
*   Trying 127.0.0.1:3128...
* Connected to localhost (127.0.0.1) port 3128 (#0)
* Proxy auth using Basic with user 'user1'
> GET http://example.com/ HTTP/1.1
> Host: example.com
> Proxy-Authorization: Basic dXNlcjE6cGFzczE=
> User-Agent: curl/7.81.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: text/html; charset=UTF-8
< Content-Length: 1256
... (response from example.com)
[/output]
```

--------------------------------

### Example error due to network misconfiguration

Source: https://betterstack.com/docs/logs/google-cloud-pubsub

Example error that may occur when the job is created in the default network and the network is not found. Customize the network or subnetwork to avoid this.

```plain
Failed to start the VM used for launching because of status code: INVALID_ARGUMENT,
reason: Invalid Error: Message: Invalid value for field
‘resource.networkInterfaces[0].network’: ‘global/networks/default’.
The referenced network resource cannot be found.
```

--------------------------------

### Start Elasticsearch exporter on Linux or macOS

Source: https://betterstack.com/docs/logs/elasticsearch

Starts the Elasticsearch exporter on Linux (systemctl) or macOS (launchctl).

```sh
systemctl start elasticsearch_exporter
```

```sh
launchctl start com.prometheus.elasticsearch_exporter
```

--------------------------------

### List roles cURL example

Source: https://betterstack.com/docs/uptime/api/roles/list

Example cURL command to list all roles. Sends a GET request to the /api/v2/roles endpoint with an Authorization header using a Bearer token.

```shell
curl --request GET \
  --url "https://betterstack.com/api/v2/roles" \
  --header "Authorization: Bearer $TOKEN"
```

--------------------------------

### Install Vector on Red Hat-based Linux or macOS

Source: https://betterstack.com/docs/logs/ingesting-data/logs/docker-kubernetes

Installs Vector using the official installer script on Red Hat-based Linux or macOS.

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.vector.dev | sh -s -- -y

```

--------------------------------

### Install Better Stack Helm chart

Source: https://betterstack.com/docs/logs/kubernetes

Two ways to install the Better Stack chart: with the default metrics server, or without it using the --set metrics-server.enabled=false flag. The second option is for clusters that already have a metrics server installed.

```sh
helm install betterstack-logs betterstack-logs/betterstack-logs -f values.yaml
```

```sh
helm install betterstack-logs betterstack-logs/betterstack-logs -f values.yaml \
  --set metrics-server.enabled=false
```

--------------------------------

### Error response for invalid date range

Source: https://betterstack.com/docs/uptime/api/get-a-heartbeats-availability-summary

Example 400 response body when the optional from and to dates are invalid (e.g., start date in the future or end date before start date).

```json
{
  "errors": "The data range is invalid. The date format could not be parsed, the start time is in the future, or the end time is before the start time."
}
```

--------------------------------

### Install logtail-python

Source: https://betterstack.com/docs/logs/python

Install the Better Stack Python PyPI package. Requires Python 3.10 or higher and pip version 20.0.2 or higher.

```bash
pip3 install logtail-python
```

--------------------------------

### Install Serilog packages with dotnet CLI

Source: https://betterstack.com/docs/logs/net-c

Install the Serilog.Extensions.Logging and BetterStack.Logs.Serilog packages using the .NET CLI. Requires .NET Framework 4.6.2+, .NET Core 2.0+, or .NET 5+.

```bash
dotnet add package Serilog.Extensions.Logging
dotnet add package BetterStack.Logs.Serilog
```

--------------------------------

### Get incident cURL request

Source: https://betterstack.com/docs/uptime/api/list-a-single-incident

Example cURL command to retrieve a specific incident by ID.

```shell
curl --request GET \
  --url https://incidents.betterstack.com/api/v3/incidents/123456789 \
  --header "Authorization: Bearer $TOKEN"
```

--------------------------------

### Start Redis exporter on Linux or macOS

Source: https://betterstack.com/docs/logs/redis

Start the Redis exporter on Linux or macOS. Use the command that matches your operating system.

```sh
systemctl start redis_exporter
```

```sh
launchctl start com.prometheus.redis_exporter
```

--------------------------------

### cURL Request: Get Single Dashboard Alert

Source: https://betterstack.com/docs/logs/api/dashboard-alerts/get

Example cURL request to retrieve a single dashboard alert by its ID. Uses the GET method with the Authorization header set to Bearer $TOKEN.

```shell
curl --request GET \
     --url "https://telemetry.betterstack.com/api/v2/dashboards/123/charts/456/alerts/789" \
     --header "Authorization: Bearer $TOKEN"
```

--------------------------------

### Install NLog packages with dotnet CLI

Source: https://betterstack.com/docs/logs/net-c

Install the NLog.Extensions.Logging and BetterStack.Logs.NLog packages using the .NET CLI. This is the first step to set up NLog logging with Better Stack.

```bash
dotnet add package NLog.Extensions.Logging
dotnet add package BetterStack.Logs.NLog
```

--------------------------------

### Install @logtail/js npm package

Source: https://betterstack.com/docs/logs/javascript/install

Install the @logtail/js npm package to enable logging from both backend and frontend code.

```bash
npm install @logtail/js
```

--------------------------------

### List catalog relations cURL example

Source: https://betterstack.com/docs/uptime/api/catalog-integrations-relations

Example cURL command to list all catalog relations. Replace $TOKEN with your API token from Settings → API tokens.

```bash
curl --request GET \
  --url https://incidents.betterstack.com/api/v2/catalog/relations \
  --header "Authorization: Bearer $TOKEN"
```

--------------------------------

### Install Python OTLP HTTP exporter

Source: https://betterstack.com/docs/logs/open-telemetry

Install the required OpenTelemetry OTLP HTTP exporter package for Python before sending telemetry.

```sh
pip install opentelemetry-exporter-otlp-proto-http
```

--------------------------------

### Set up the client for browser

Source: https://betterstack.com/docs/logs/javascript/install

Sets up the Better Stack client for browser logging using ES module import.

```javascript
import { Logtail } from "@logtail/browser";
const logtail = new Logtail("$SOURCE_TOKEN", {
  endpoint: 'https://$INGESTING_HOST',
});

// Forward console.log(), console.warn() and similar to Better Stack too
logtail.replaceConsoleMethods();
```

--------------------------------

### Set up Vector for Elasticsearch on Linux (setup-script-supported)

Source: https://betterstack.com/docs/logs/elasticsearch

Installs Vector using the official package, configures it for your Better Stack source, and enables/restarts the service. The script asks for confirmation before making any changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/elasticsearch/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### 200 Response: Threshold and Anomaly Alert Examples

Source: https://betterstack.com/docs/logs/api/dashboard-alerts/get

Example 200 responses for the Get a single dashboard alert endpoint, showing the full alert object for a threshold alert and an anomaly alert. The response includes attributes such as alert_type, notification settings, and metadata.

```json
{
  "data": {
    "id": "12345",
    "type": "alert",
    "attributes": {
      "dashboard_id": 123,
      "chart_id": 456,
      "name": "High Error Rate",
      "alert_type": "threshold",
      "operator": "higher_than",
      "value": 100.0,
      "string_value": null,
      "check_period": 300,
      "on_missing_data": "dont_fire",
      "query_period": 600,
      "confirmation_period": 120,
      "recovery_period": 60,
      "aggregation_interval": 300,
      "series_names": [],
      "series_names_except": [],
      "source_variable": null,
      "source_mode": "source_variable",
      "source_platforms": [],
      "incident_cause": "Error rate exceeded {{value}}",
      "incident_per_series": false,
      "call": true,
      "sms": false,
      "email": true,
      "push": true,
      "critical_alert": false,
      "paused": false,
      "paused_reason": null,
      "escalation_target": "current_team",
      "metadata": {
        "runbook": "https://wiki.example.com/runbook",
        "env": "production"
      },
      "created_at": "2026-03-25T10:00:00.000Z",
      "updated_at": "2026-03-25T10:00:00.000Z"
    }
  }
}
```

```json
{
  "data": {
    "id": "12346",
    "type": "alert",
    "attributes": {
      "dashboard_id": 123,
      "chart_id": 456,
      "name": "Anomaly Detection",
      "alert_type": "anomaly_rrcf",
      "anomaly_sensitivity": 5.0,
      "anomaly_trigger": "any",
      "anomaly_training_range_days": 7,
      "query_period": 60,
      "confirmation_period": 60,
      "recovery_period": 0,
      "aggregation_interval": 60,
      "series_names": [],
      "series_names_except": [],
      "source_variable": null,
      "source_mode": "source_variable",
      "source_platforms": [],
      "incident_cause": null,
      "incident_per_series": false,
      "call": false,
      "sms": false,
      "email": true,
      "push": false,
      "critical_alert": false,
      "paused": false,
      "paused_reason": null,
      "escalation_target": "current_team",
      "metadata": {},
      "created_at": "2026-03-25T10:00:00.000Z",
      "updated_at": "2026-03-25T10:00:00.000Z"
    }
  }
}
```

--------------------------------

### Install PyPI packages for Python Lambda

Source: https://betterstack.com/docs/logs/aws-lambda

Install the required PyPI packages for Python Lambda logging. Requires Python 3.7 or higher and pip version 20.0.2 or higher.

```bash
pip3 install logtail-python
pip3 install aws-lambda-powertools
```

--------------------------------

### Set up certificates for TLS

Source: https://betterstack.com/docs/logs/syslog-setup

Download and set up Let's Encrypt CA certificates for TLS. Creates the certificate directory, downloads the TrustID X3 Root and ISRG Root X1 certificates, and creates the required symlinks for syslog-ng.

```shell
mkdir -p /etc/syslog-ng/ca.d
cd /etc/syslog-ng/ca.d

# TrustID X3 Root from IdenTrust
wget https://letsencrypt.org/certs/trustid-x3-root.pem
ln -s trustid-x3-root.pem $(openssl x509 -in trustid-x3-root.pem -hash -noout).0

# ISRG Root X1
wget https://letsencrypt.org/certs/isrgrootx1.pem
ln -s isrgrootx1.pem $(openssl x509 -in isrgrootx1.pem -hash -noout).0
```

--------------------------------

### Install Better Stack logging library for Hono

Source: https://betterstack.com/docs/logs/javascript/hono

Install the Better Stack logging library for the runtime your Hono app runs on. Use @logtail/edge for Cloudflare Workers and @logtail/node for Node.js.

```bash
npm install @logtail/edge
```

```bash
npm install @logtail/node
```

--------------------------------

### Example response for listing monitor groups

Source: https://betterstack.com/docs/uptime/api/list-all-existing-monitor-groups

Example 200 response body showing a list of monitor groups with attributes such as name, sort_index, timestamps, team_name, and paused status. Includes pagination links.

```json
{
  "data": [
    {
      "id": "95251342",
      "type": "monitor_group",
      "attributes": {
        "name": "Backend services",
        "sort_index": null,
        "created_at": "2020-10-03T20:20:43.547Z",
        "updated_at": "2020-10-03T20:20:43.547Z",
        "team_name": "Test team",
        "paused": true
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/monitor-groups?page=1",
    "last": "https://incidents.betterstack.com/api/v2/monitor-groups?page=1",
    "prev": null,
    "next": null
  }
}
```

--------------------------------

### cURL request to get a single release

Source: https://betterstack.com/docs/errors/api/releases/get

An example cURL command to retrieve a single release by its ID. Replace the ID and token as needed.

```shell
curl --request GET \
  --url https://errors.betterstack.com/api/v1/releases/456 \
  --header "Authorization: Bearer $TOKEN"
```

--------------------------------

### cURL: Get usage overview

Source: https://betterstack.com/docs/uptime/api/usage/overview

Example cURL request to retrieve the usage overview. Requires a global API token passed as a Bearer token in the Authorization header.

```shell
curl --request GET \
  --url "https://betterstack.com/api/v2/usage" \
  --header "Authorization: Bearer $TOKEN"
```

--------------------------------

### PATCH /api/v2/status-pages/{status_page_id}/subscribers/{subscriber_id} - cURL example

Source: https://betterstack.com/docs/uptime/api/update-a-single-status-page-subscriber

Updates the status page resources for an existing subscriber. Only status_page_resource_ids can be changed; to change an email address, remove the old subscriber and create a new one. Use [] for all resources. Get valid resource IDs from GET /api/v2/status-pages/{status_page_id}/resources.

```bash
curl --request PATCH \
  --url https://incidents.betterstack.com/api/v2/status-pages/987654321/subscribers/123456789 \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "status_page_resource_ids": [112233, 112234]
  }'
```

--------------------------------

### List on-call schedules response body

Source: https://betterstack.com/docs/uptime/api/on-call-calendar

Example JSON response from the GET /api/v2/on-calls endpoint, showing the list of on-call schedules with their attributes and relationships, including pagination links.

```json
{
  "data": [
    {
      "id": "12345",
      "type": "on_call_calendar",
      "attributes": {
        "name": null,
        "default_calendar": true,
        "team_name": "Production"
      },
      "relationships": {
        "on_call_users": {
          "data": [
            {
              "id": "2345",
              "type": "user",
              "meta": {
                "email": "tomas@betterstack.com"
              }
            }
          ]
        }
      }
    },
    {
      "id": "12346",
      "type": "on_call_calendar",
      "attributes": {
        "name": "Tier 2",
        "default_calendar": false
      },
      "relationships": {
        "on_call_users": {
          "data": [
            {
              "id": "2345",
              "type": "user",
              "meta": {
                "email": "tomas@betterstack.com"
              }
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "2345",
      "type": "user",
      "attributes": {
        "first_name": "Tomas",
        "last_name": "Hromada",
        "email": "tomas@betterstack.com",
        "phone_numbers": [
          "+420737123456"
        ]
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/on-calls?page=1",
    "last": "https://incidents.betterstack.com/api/v2/on-calls?page=1",
    "prev": null,
    "next": null
  }
}
```

--------------------------------

### List Splunk integrations with cURL

Source: https://betterstack.com/docs/uptime/api/list-all-splunk-on-call-integrations

cURL example to list all Splunk On-Call integrations. Sends a GET request to the endpoint with the required Authorization header using a bearer token.

```shell
curl --request GET \
  --url https://incidents.betterstack.com/api/v2/splunk-on-calls \
  --header "Authorization: Bearer $TOKEN"
```

--------------------------------

### Set up MySQL database user

Source: https://betterstack.com/docs/logs/collector

Creates a MySQL user named 'betterstack' with the required permissions (SELECT, PROCESS, REPLICATION CLIENT) to collect database metrics. Replace '<PASSWORD>' with a strong password.

```sql
CREATE USER 'betterstack'@'%' IDENTIFIED BY '<PASSWORD>';
GRANT SELECT, PROCESS, REPLICATION CLIENT ON *.* TO 'betterstack'@'%';
```

--------------------------------

### cURL example for GET comment

Source: https://betterstack.com/docs/uptime/api/list-a-single-comment

Use this cURL command to retrieve a comment by incident ID and comment ID. Replace the IDs in the URL and set the Authorization header with your Bearer token.

```shell
curl --url https://incidents.betterstack.com/api/v2/incidents/1/comments/1 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json'
```

--------------------------------

### Set up slog-betterstack handler and start logging

Source: https://betterstack.com/docs/logs/go

Configure slog-betterstack as a handler in a new slog logger. Log events are sent to Better Stack automatically. Replace $SOURCE_TOKEN and $INGESTING_HOST with your actual values.

```go
import (
    slogbetterstack "github.com/samber/slog-betterstack"
    "log/slog"
)

func main() {
    logger := slog.New(
        slogbetterstack.Option{
            Token: "$SOURCE_TOKEN",
            Endpoint: "https://$INGESTING_HOST/",
        }.NewBetterstackHandler(),
    )

    // Logger is ready to be used
    logger.Info("Hello from Better Stack!")
}
```

--------------------------------

### Example response for get on-call schedule

Source: https://betterstack.com/docs/uptime/api/get-a-single-on-call-calendar

Shows the JSON response returned with status 200 when a single on-call schedule is successfully retrieved. It includes the schedule attributes and related on-call users.

```json
{
  "data": {
    "id": "12345",
    "type": "on_call_calendar",
    "attributes": {
      "name": null,
      "default_calendar": true,
      "team_name": "Production"
    },
    "relationships": {
      "on_call_users": {
        "data": [
          {
            "id": "2345",
            "type": "user",
            "meta": { 
              "email": "tomas@uptime.betterstack.com"
            }
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "2345",
      "type": "user",
      "attributes": {
        "first_name": "Tomas",
        "last_name": "Hromada",
        "email": "tomas@uptime.betterstack.com",
        "phone_numbers": [
          "+420737123456"
        ]
      }
    }
  ]
}
```

--------------------------------

### betterstack('init', opts)

Source: https://betterstack.com/docs/errors/js-tag/install

Initializes BetterStack data collection with optional configuration options.

```APIDOC
## betterstack('init', opts)

### Description
Initializes data collection for BetterStack. Call this once at the start of your application to begin tracking errors, events, and session replays.

### Method
`betterstack('init', opts)`

### Parameters
#### Options Object
- **environment** (string) - Optional - Environment name (e.g., `'production'`, `'staging'`). Passed to error tracking for filtering.
- **release** (string) - Optional - App version or release identifier. Useful for tracking regressions across deployments.
- **autoPageview** (boolean) - Optional - Default: `true` - Automatically track page views. Set to `false` to track navigation manually.
- **debug** (boolean) - Optional - Default: `false` - Log internal activity to the browser console. Useful during development.

### Request Example
```javascript
betterstack('init', {
  environment: 'production',
  release: '1.4.2',
});
```

### Response
No return value documented.
```

--------------------------------

### Set up Vector for Apache on Linux/macOS

Source: https://betterstack.com/docs/logs/apache

Run this script on Ubuntu, Debian, Red Hat-based Linux, or macOS to install Vector, configure it for your Better Stack source, and enable/restart the service. The script will ask for confirmation before making any changes.

```bash
curl -sSL https://telemetry.betterstack.com/setup-vector/apache/$SOURCE_TOKEN \
  -o /tmp/setup-vector.sh && \
  bash /tmp/setup-vector.sh
```

--------------------------------

### Send test log with logger

Source: https://betterstack.com/docs/logs/rsyslog-setup

Sends a test log to verify the manual setup. The log should appear in Better Stack Live tail.

```bash
logger "Hello from Better Stack!"
```

--------------------------------

### Set up the client for Node.js

Source: https://betterstack.com/docs/logs/javascript/install

Sets up the Better Stack client for Node.js. Requires Node.js 12 or higher. The replaceConsoleMethods() call forwards console methods to Better Stack.

```javascript
const { Logtail } = require("@logtail/node");
const logtail = new Logtail("$SOURCE_TOKEN", {
  endpoint: 'https://$INGESTING_HOST',
});

// Forward console.log(), console.warn() and similar to Better Stack too
logtail.replaceConsoleMethods();
```
Tokens:
Raw