Typesense

Plugin: go.d.plugin Module: typesense

Overview

This collector monitors the overall health status and performance of your Typesense servers. It gathers detailed metrics, including the total number of requests processed, the breakdown of different request types, and the average latency experienced by each request.

It gathers metrics by periodically issuing HTTP GET requests to the Typesense server:

• /health endpoint to check server health.
• /stats.json endpoint to collect data on requests and latency.

This collector is supported on all platforms.

This collector only supports collecting metrics from a single instance of this integration.

Default Behavior

Auto-Detection

The collector can automatically detect Typesense instances running on:

• localhost that are listening on port 8108
• within Docker containers

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Typesense instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

Metric	Dimensions	Unit
typesense.health_status	ok, out_of_disk, out_of_memory	status
typesense.total_requests	requests	requests/s
typesense.requests_by_operation	search, write, import, delete	requests/s
typesense.latency_by_operation	search, write, import, delete	milliseconds
typesense.overloaded_requests	overloaded	requests/s

Alerts

There are no alerts configured by default for this integration.

Setup

You can configure the typesense collector in two ways:

Method	Best for	How to
UI	Fast setup without editing files	Go to Nodes → Configure this node → Collectors → Jobs, search for typesense, then click + to add a job.
File	If you prefer configuring via file, or need to automate deployments (e.g., with Ansible)	Edit go.d/typesense.conf and add a job.

important

UI configuration requires paid Netdata Cloud plan.

Prerequisites

API Key Configuration

While optional, configuring an API key is highly recommended to enable the collector to gather stats metrics, including request counts and latency. Without an API key, the collector will only collect health status information.

If you're running Typesense with the API key provided as a command-line parameter (e.g., --api-key=XYZ), Netdata can automatically detect and use this key for queries. In this case, no additional configuration is required.

Configuration

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options

Group	Option	Description	Default	Required
Collection	update_every	Data collection interval (seconds).	1	no
	autodetection_retry	Autodetection retry interval (seconds). Set 0 to disable.	0	no
Target	url	Target endpoint URL.	http://127.0.0.1:8108	yes
	timeout	HTTP request timeout (seconds).	1	no
HTTP Auth	api_key	Typesense API key (X-TYPESENSE-API-KEY). See API Keys.		no
	username	Username for Basic HTTP authentication.		no
	password	Password for Basic HTTP authentication.		no
	bearer_token_file	Path to a file containing a bearer token (used for Authorization: Bearer).		no
TLS	tls_skip_verify	Skip TLS certificate and hostname verification (insecure).	no	no
	tls_ca	Path to CA bundle used to validate the server certificate.		no
	tls_cert	Path to client TLS certificate (for mTLS).		no
	tls_key	Path to client TLS private key (for mTLS).		no
Proxy	proxy_url	HTTP proxy URL.		no
	proxy_username	Username for proxy Basic HTTP authentication.		no
	proxy_password	Password for proxy Basic HTTP authentication.		no
Request	method	HTTP method to use.	GET	no
	body	Request body (e.g., for POST/PUT).		no
	headers	Additional HTTP headers (one per line as key: value).		no
	not_follow_redirects	Do not follow HTTP redirects.	no	no
	force_http2	Force HTTP/2 (including h2c over TCP).	no	no
Virtual Node	vnode	Associates this data collection job with a Virtual Node.		no

via UI

Configure the typesense collector from the Netdata web interface:

1. Go to Nodes.
2. Select the node where you want the typesense data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
3. The Collectors → Jobs view opens by default.
4. In the Search box, type typesense (or scroll the list) to locate the typesense collector.
5. Click the + next to the typesense collector to add a new job.
6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
   • Test runs the job with the provided settings and shows whether data can be collected.
   • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/typesense.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/typesense.conf

Examples

Basic

A basic example configuration.

jobs:
  - name: local
    url: http://127.0.0.1:8108
    api_key: XYZ

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

Config

jobs:
  - name: local
    url: http://127.0.0.1:8108
    api_key: XYZ

  - name: remote
    url: http://192.0.2.1:8108
    api_key: XYZ

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the typesense collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/

• Switch to the netdata user.

  sudo -u netdata -s

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m typesense

  To debug a specific job:

  ./go.d.plugin -d -m typesense -j jobName

Getting Logs

If you're encountering problems with the typesense collector, follow these steps to retrieve logs and identify potential issues:

• Run the command specific to your system (systemd, non-systemd, or Docker container).
• Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep typesense

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep typesense /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep typesense