Supported OS
![Linux]()
![Windows]()
Overview
Track request level metrics for your Bonsai clusters to:
- Visualize the performance of your clusters
- Correlate search performance with application performance
- Create alerts
Setup
Integrating your cluster with Datadog requires submitting your API key to the bonsai app.
Acquire API key
In Datadog, navigate to Integrations –> API and copy your API Key.
Submit API key
Navigate to Bonsai –> Clusters and click the cluster you want to integrate. Navigate to the Manage tab and scroll to the bottom of the page.
Under the “Datadog Integration” section paste your API key and click “Activate Datadog”.
Verify
If your key is valid, you should see the integration as active.
Within a few minutes, request metrics are available in your Datadog dashboard.
Data Collected
Metrics
bonsai.req.2xx
(gauge) | Number of requests with a 2xx (successful) response code
Shown as request |
bonsai.req.4xx
(gauge) | Number of requests with a 4xx (client error) response code
Shown as request |
bonsai.req.5xx
(gauge) | Number of requests with a 5xx (server error) response code
Shown as request |
bonsai.req.max_concurrency
(gauge) | Peak concurrent requests
Shown as connection |
bonsai.req.p50
(gauge) | The median request duration
Shown as minute |
bonsai.req.p95
(gauge) | The 95th percentile request duration
Shown as minute |
bonsai.req.p99
(gauge) | The 99th percentile request duration
Shown as minute |
bonsai.req.queue_depth
(gauge) | Peak queue depth (how many requests are waiting due to concurrency limits)
Shown as connection |
bonsai.req.reads
(gauge) | The number of requests which read data
Shown as request |
bonsai.req.rx_bytes
(gauge) | The number of bytes sent to elasticsearch
Shown as byte |
bonsai.req.total
(gauge) | The total number of requests
Shown as request |
bonsai.req.tx_bytes
(gauge) | The number of bytes sent to client
Shown as byte |
bonsai.req.writes
(gauge) | The total number of writes
Shown as request |
Metrics are tagged for each cluster, so you can segment based on clusters. The tags look like:
Events
The Bonsai integration does not include any events.
Service Checks
The Bonsai integration does not include any service checks.
Troubleshooting
Need help? Contact Datadog Support.
