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

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

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_name1

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

Options

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

Config options

Name	Description	Default	Required
update_every	Data collection frequency.	1	no
autodetection_retry	Recheck interval in seconds. Zero means no recheck will be scheduled.	0	no
url	Server URL.	http://127.0.0.1:8108	yes
timeout	HTTP request timeout.	1	no
api_key	The Typesense API Key (X-TYPESENSE-API-KEY).		no
username	Username for basic HTTP authentication.		no
password	Password for basic HTTP authentication.		no
proxy_url	Proxy URL.		no
proxy_username	Username for proxy basic HTTP authentication.		no
proxy_password	Password for proxy basic HTTP authentication.		no
method	HTTP request method.	GET	no
body	HTTP request body.		no
headers	HTTP request headers.		no
not_follow_redirects	Redirect handling policy. Controls whether the client follows redirects.	no	no
tls_skip_verify	Server certificate chain and hostname validation policy. Controls whether the client performs this check.	no	no
tls_ca	Certification authority that the client uses when verifying the server's certificates.		no
tls_cert	Client TLS certificate.		no
tls_key	Client TLS key.		no

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