@cryptotaxi247 / netdata-1 / commits / e8754742a

Regenerate integrations.js (#18543)

Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>

Netdata bot committed Sep 13, 2024 at 05:48 UTC e8754742ab4f7fa4e8e9411ad096087dbfbbfa27
5 files changed +324
integrations/integrations.js
+38
@@ -16900,6 +16900,44 @@ export const integrations = [
16900 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/traefik/metadata.yaml",
16901 "related_resources": ""
16902 },
16903 + {
16904 + "meta": {
16905 + "id": "collector-go.d.plugin-typesense",
16906 + "plugin_name": "go.d.plugin",
16907 + "module_name": "typesense",
16908 + "monitored_instance": {
16909 + "name": "Typesense",
16910 + "link": "https://typesense.org/",
16911 + "categories": [
16912 + "data-collection.search-engines"
16913 + ],
16914 + "icon_filename": "typesense.svg"
16915 + },
16916 + "related_resources": {
16917 + "integrations": {
16918 + "list": []
16919 + }
16920 + },
16921 + "alternative_monitored_instances": [],
16922 + "info_provided_to_referring_integrations": {
16923 + "description": ""
16924 + },
16925 + "keywords": [
16926 + "typesense",
16927 + "search engine"
16928 + ],
16929 + "most_popular": false
16930 + },
16931 + "overview": "# Typesense\n\nPlugin: go.d.plugin\nModule: typesense\n\n## Overview\n\nThis collector monitors the overall health status and performance of your Typesense servers.\nIt gathers detailed metrics, including the total number of requests processed, the breakdown of different request types, and the average latency experienced by each request.\n\n\nIt gathers metrics by periodically issuing HTTP GET requests to the Typesense server:\n\n- [/health](https://typesense.org/docs/27.0/api/cluster-operations.html#health) endpoint to check server health.\n- [/stats.json](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats) endpoint to collect data on requests and latency.\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector can automatically detect Typesense instances running on:\n\n- localhost that are listening on port 8108\n- within Docker containers\n\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
16932 + "setup": "## Setup\n\n### Prerequisites\n\n#### API Key Configuration\n\nWhile optional, configuring an [API key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) is highly recommended to enable the collector to gather [stats metrics](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats), including request counts and latency.\nWithout an API key, the collector will only collect health status information.\n\n> 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.\n> In this case, no additional configuration is required.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/typesense.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/typesense.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 1 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| url | Server URL. | http://127.0.0.1:8108 | yes |\n| timeout | HTTP request timeout. | 1 | no |\n| api_key | The Typesense [API Key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) (`X-TYPESENSE-API-KEY`). | | no |\n| username | Username for basic HTTP authentication. | | no |\n| password | Password for basic HTTP authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTP authentication. | | no |\n| proxy_password | Password for proxy basic HTTP authentication. | | no |\n| method | HTTP request method. | GET | no |\n| body | HTTP request body. | | no |\n| headers | HTTP request headers. | | no |\n| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |\n| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |\n| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |\n| tls_cert | Client TLS certificate. | | no |\n| tls_key | Client TLS key. | | no |\n\n{% /details %}\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8108\n api_key: XYZ\n\n```\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nCollecting metrics from local and remote instances.\n\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8108\n api_key: XYZ\n\n - name: remote\n url: http://192.0.2.1:8108\n api_key: XYZ\n\n```\n{% /details %}\n",
16933 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `typesense` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m typesense\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `typesense` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **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.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep typesense\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep typesense /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep typesense\n```\n\n",
16934 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
16935 + "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per Typesense instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| typesense.health_status | ok, out_of_disk, out_of_memory | status |\n| typesense.total_requests | requests | requests/s |\n| typesense.requests_by_operation | search, write, import, delete | requests/s |\n| typesense.latency_by_operation | search, write, import, delete | milliseconds |\n| typesense.overloaded_requests | overloaded | requests/s |\n\n",
16936 + "integration_type": "collector",
16937 + "id": "go.d.plugin-typesense-Typesense",
16938 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/typesense/metadata.yaml",
16939 + "related_resources": ""
16940 + },
16941 {
16942 "meta": {
16943 "id": "collector-go.d.plugin-unbound",
integrations/integrations.json
+38
@@ -16898,6 +16898,44 @@
16898 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/traefik/metadata.yaml",
16899 "related_resources": ""
16900 },
16901 + {
16902 + "meta": {
16903 + "id": "collector-go.d.plugin-typesense",
16904 + "plugin_name": "go.d.plugin",
16905 + "module_name": "typesense",
16906 + "monitored_instance": {
16907 + "name": "Typesense",
16908 + "link": "https://typesense.org/",
16909 + "categories": [
16910 + "data-collection.search-engines"
16911 + ],
16912 + "icon_filename": "typesense.svg"
16913 + },
16914 + "related_resources": {
16915 + "integrations": {
16916 + "list": []
16917 + }
16918 + },
16919 + "alternative_monitored_instances": [],
16920 + "info_provided_to_referring_integrations": {
16921 + "description": ""
16922 + },
16923 + "keywords": [
16924 + "typesense",
16925 + "search engine"
16926 + ],
16927 + "most_popular": false
16928 + },
16929 + "overview": "# Typesense\n\nPlugin: go.d.plugin\nModule: typesense\n\n## Overview\n\nThis collector monitors the overall health status and performance of your Typesense servers.\nIt gathers detailed metrics, including the total number of requests processed, the breakdown of different request types, and the average latency experienced by each request.\n\n\nIt gathers metrics by periodically issuing HTTP GET requests to the Typesense server:\n\n- [/health](https://typesense.org/docs/27.0/api/cluster-operations.html#health) endpoint to check server health.\n- [/stats.json](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats) endpoint to collect data on requests and latency.\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector can automatically detect Typesense instances running on:\n\n- localhost that are listening on port 8108\n- within Docker containers\n\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
16930 + "setup": "## Setup\n\n### Prerequisites\n\n#### API Key Configuration\n\nWhile optional, configuring an [API key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) is highly recommended to enable the collector to gather [stats metrics](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats), including request counts and latency.\nWithout an API key, the collector will only collect health status information.\n\n> 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.\n> In this case, no additional configuration is required.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/typesense.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/typesense.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 1 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| url | Server URL. | http://127.0.0.1:8108 | yes |\n| timeout | HTTP request timeout. | 1 | no |\n| api_key | The Typesense [API Key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) (`X-TYPESENSE-API-KEY`). | | no |\n| username | Username for basic HTTP authentication. | | no |\n| password | Password for basic HTTP authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTP authentication. | | no |\n| proxy_password | Password for proxy basic HTTP authentication. | | no |\n| method | HTTP request method. | GET | no |\n| body | HTTP request body. | | no |\n| headers | HTTP request headers. | | no |\n| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |\n| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |\n| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |\n| tls_cert | Client TLS certificate. | | no |\n| tls_key | Client TLS key. | | no |\n\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8108\n api_key: XYZ\n\n```\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nCollecting metrics from local and remote instances.\n\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8108\n api_key: XYZ\n\n - name: remote\n url: http://192.0.2.1:8108\n api_key: XYZ\n\n```\n",
16931 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `typesense` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m typesense\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `typesense` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **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.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep typesense\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep typesense /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep typesense\n```\n\n",
16932 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
16933 + "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per Typesense instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| typesense.health_status | ok, out_of_disk, out_of_memory | status |\n| typesense.total_requests | requests | requests/s |\n| typesense.requests_by_operation | search, write, import, delete | requests/s |\n| typesense.latency_by_operation | search, write, import, delete | milliseconds |\n| typesense.overloaded_requests | overloaded | requests/s |\n\n",
16934 + "integration_type": "collector",
16935 + "id": "go.d.plugin-typesense-Typesense",
16936 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/typesense/metadata.yaml",
16937 + "related_resources": ""
16938 + },
16939 {
16940 "meta": {
16941 "id": "collector-go.d.plugin-unbound",
src/collectors/COLLECTORS.md
+2
@@ -921,6 +921,8 @@ If you don't see the app/service you'd like to monitor in this list:
921
922 - [Sphinx](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/sphinx.md)
923
924 +- [Typesense](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/typesense/integrations/typesense.md)
925 +
926 ### Security Systems
927
928 - [Certificate Transparency](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/certificate_transparency.md)
src/go/plugin/go.d/modules/typesense/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/typesense.md
\ No newline at end of file
src/go/plugin/go.d/modules/typesense/integrations/typesense.md new
+245
@@ -0,0 +1,245 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/typesense/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/typesense/metadata.yaml"
4 +sidebar_label: "Typesense"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Search Engines"
7 +most_popular: False
8 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9 +endmeta-->
10 +
11 +# Typesense
12 +
13 +
14 +<img src="https://netdata.cloud/img/typesense.svg" width="150"/>
15 +
16 +
17 +Plugin: go.d.plugin
18 +Module: typesense
19 +
20 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21 +
22 +## Overview
23 +
24 +This collector monitors the overall health status and performance of your Typesense servers.
25 +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.
26 +
27 +
28 +It gathers metrics by periodically issuing HTTP GET requests to the Typesense server:
29 +
30 +- [/health](https://typesense.org/docs/27.0/api/cluster-operations.html#health) endpoint to check server health.
31 +- [/stats.json](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats) endpoint to collect data on requests and latency.
32 +
33 +
34 +This collector is supported on all platforms.
35 +
36 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
37 +
38 +
39 +### Default Behavior
40 +
41 +#### Auto-Detection
42 +
43 +The collector can automatically detect Typesense instances running on:
44 +
45 +- localhost that are listening on port 8108
46 +- within Docker containers
47 +
48 +
49 +#### Limits
50 +
51 +The default configuration for this integration does not impose any limits on data collection.
52 +
53 +#### Performance Impact
54 +
55 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
56 +
57 +
58 +## Metrics
59 +
60 +Metrics grouped by *scope*.
61 +
62 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
63 +
64 +
65 +
66 +### Per Typesense instance
67 +
68 +These metrics refer to the entire monitored application.
69 +
70 +This scope has no labels.
71 +
72 +Metrics:
73 +
74 +| Metric | Dimensions | Unit |
75 +|:------|:----------|:----|
76 +| typesense.health_status | ok, out_of_disk, out_of_memory | status |
77 +| typesense.total_requests | requests | requests/s |
78 +| typesense.requests_by_operation | search, write, import, delete | requests/s |
79 +| typesense.latency_by_operation | search, write, import, delete | milliseconds |
80 +| typesense.overloaded_requests | overloaded | requests/s |
81 +
82 +
83 +
84 +## Alerts
85 +
86 +There are no alerts configured by default for this integration.
87 +
88 +
89 +## Setup
90 +
91 +### Prerequisites
92 +
93 +#### API Key Configuration
94 +
95 +While optional, configuring an [API key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) is highly recommended to enable the collector to gather [stats metrics](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats), including request counts and latency.
96 +Without an API key, the collector will only collect health status information.
97 +
98 +> 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.
99 +> In this case, no additional configuration is required.
100 +
101 +
102 +
103 +### Configuration
104 +
105 +#### File
106 +
107 +The configuration file name for this integration is `go.d/typesense.conf`.
108 +
109 +
110 +You can edit the configuration file using the `edit-config` script from the
111 +Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
112 +
113 +```bash
114 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
115 +sudo ./edit-config go.d/typesense.conf
116 +```
117 +#### Options
118 +
119 +The following options can be defined globally: update_every, autodetection_retry.
120 +
121 +
122 +<details open><summary>Config options</summary>
123 +
124 +| Name | Description | Default | Required |
125 +|:----|:-----------|:-------|:--------:|
126 +| update_every | Data collection frequency. | 1 | no |
127 +| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
128 +| url | Server URL. | http://127.0.0.1:8108 | yes |
129 +| timeout | HTTP request timeout. | 1 | no |
130 +| api_key | The Typesense [API Key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) (`X-TYPESENSE-API-KEY`). | | no |
131 +| username | Username for basic HTTP authentication. | | no |
132 +| password | Password for basic HTTP authentication. | | no |
133 +| proxy_url | Proxy URL. | | no |
134 +| proxy_username | Username for proxy basic HTTP authentication. | | no |
135 +| proxy_password | Password for proxy basic HTTP authentication. | | no |
136 +| method | HTTP request method. | GET | no |
137 +| body | HTTP request body. | | no |
138 +| headers | HTTP request headers. | | no |
139 +| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |
140 +| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
141 +| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |
142 +| tls_cert | Client TLS certificate. | | no |
143 +| tls_key | Client TLS key. | | no |
144 +
145 +</details>
146 +
147 +#### Examples
148 +
149 +##### Basic
150 +
151 +A basic example configuration.
152 +
153 +```yaml
154 +jobs:
155 + - name: local
156 + url: http://127.0.0.1:8108
157 + api_key: XYZ
158 +
159 +```
160 +##### Multi-instance
161 +
162 +> **Note**: When you define multiple jobs, their names must be unique.
163 +
164 +Collecting metrics from local and remote instances.
165 +
166 +
167 +<details open><summary>Config</summary>
168 +
169 +```yaml
170 +jobs:
171 + - name: local
172 + url: http://127.0.0.1:8108
173 + api_key: XYZ
174 +
175 + - name: remote
176 + url: http://192.0.2.1:8108
177 + api_key: XYZ
178 +
179 +```
180 +</details>
181 +
182 +
183 +
184 +## Troubleshooting
185 +
186 +### Debug Mode
187 +
188 +**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
189 +
190 +To troubleshoot issues with the `typesense` collector, run the `go.d.plugin` with the debug option enabled. The output
191 +should give you clues as to why the collector isn't working.
192 +
193 +- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
194 + your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
195 +
196 + ```bash
197 + cd /usr/libexec/netdata/plugins.d/
198 + ```
199 +
200 +- Switch to the `netdata` user.
201 +
202 + ```bash
203 + sudo -u netdata -s
204 + ```
205 +
206 +- Run the `go.d.plugin` to debug the collector:
207 +
208 + ```bash
209 + ./go.d.plugin -d -m typesense
210 + ```
211 +
212 +### Getting Logs
213 +
214 +If you're encountering problems with the `typesense` collector, follow these steps to retrieve logs and identify potential issues:
215 +
216 +- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
217 +- **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.
218 +
219 +#### System with systemd
220 +
221 +Use the following command to view logs generated since the last Netdata service restart:
222 +
223 +```bash
224 +journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep typesense
225 +```
226 +
227 +#### System without systemd
228 +
229 +Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
230 +
231 +```bash
232 +grep typesense /var/log/netdata/collector.log
233 +```
234 +
235 +**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
236 +
237 +#### Docker Container
238 +
239 +If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
240 +
241 +```bash
242 +docker logs netdata 2>&1 | grep typesense
243 +```
244 +
245 +