diff options
Diffstat (limited to '')
| -rw-r--r-- | src/go/plugin/go.d/modules/memcached/integrations/memcached.md (renamed from src/collectors/python.d.plugin/memcached/integrations/memcached.md) | 114 |
1 files changed, 65 insertions, 49 deletions
diff --git a/src/collectors/python.d.plugin/memcached/integrations/memcached.md b/src/go/plugin/go.d/modules/memcached/integrations/memcached.md index 5e813eac2..1e653902f 100644 --- a/src/collectors/python.d.plugin/memcached/integrations/memcached.md +++ b/src/go/plugin/go.d/modules/memcached/integrations/memcached.md @@ -1,6 +1,6 @@ <!--startmeta -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/python.d.plugin/memcached/README.md" -meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/python.d.plugin/memcached/metadata.yaml" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/memcached/README.md" +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/memcached/metadata.yaml" sidebar_label: "Memcached" learn_status: "Published" learn_rel_path: "Collecting Metrics/Databases" @@ -14,7 +14,7 @@ endmeta--> <img src="https://netdata.cloud/img/memcached.svg" width="150"/> -Plugin: python.d.plugin +Plugin: go.d.plugin Module: memcached <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> @@ -23,7 +23,7 @@ Module: memcached Monitor Memcached metrics for proficient in-memory key-value store operations. Track cache hits, misses, and memory usage for efficient data caching. -It reads server response to stats command ([stats interface](https://github.com/memcached/memcached/wiki/Commands#stats)). +It reads the server's response to the `stats` command. This collector is supported on all platforms. @@ -103,7 +103,7 @@ No action required. #### File -The configuration file name for this integration is `python.d/memcached.conf`. +The configuration file name for this integration is `go.d/memcached.conf`. You can edit the configuration file using the `edit-config` script from the @@ -111,75 +111,56 @@ Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netda ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata -sudo ./edit-config python.d/memcached.conf +sudo ./edit-config go.d/memcached.conf ``` #### Options -There are 2 sections: - -* Global variables -* One or more JOBS that can define multiple different instances to monitor. - -The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values. - -Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition. - -Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified. +The following options can be defined globally: update_every, autodetection_retry. <details open><summary>Config options</summary> | Name | Description | Default | Required | |:----|:-----------|:-------|:--------:| -| host | the host to connect to. | 127.0.0.1 | no | -| port | the port to connect to. | 11211 | no | -| update_every | Sets the default data collection frequency. | 10 | no | -| priority | Controls the order of charts at the netdata dashboard. | 60000 | no | -| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no | -| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no | -| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | no | +| update_every | Data collection frequency. | 1 | no | +| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | +| address | The IP address and port where the memcached service listens for connections. | 127.0.0.1:11211 | yes | +| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no | </details> #### Examples -##### localhost - -An example configuration for localhost. - -```yaml -localhost: - name: 'local' - host: 'localhost' - port: 11211 - -``` -##### localipv4 +##### Basic -An example configuration for localipv4. +A basic example configuration. <details open><summary>Config</summary> ```yaml -localhost: - name: 'local' - host: '127.0.0.1' - port: 11211 +jobs: + - name: local + address: 127.0.0.1:11211 ``` </details> -##### localipv6 +##### Multi-instance + +> **Note**: When you define multiple jobs, their names must be unique. + +Collecting metrics from local and remote instances. -An example configuration for localipv6. <details open><summary>Config</summary> ```yaml -localhost: - name: 'local' - host: '::1' - port: 11211 +jobs: + - name: local + address: 127.0.0.1:11211 + + - name: remote + address: 203.0.113.0:11211 ``` </details> @@ -190,7 +171,9 @@ localhost: ### Debug Mode -To troubleshoot issues with the `memcached` collector, run the `python.d.plugin` with the debug option enabled. The output +**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature. + +To troubleshoot issues with the `memcached` 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 @@ -206,10 +189,43 @@ should give you clues as to why the collector isn't working. sudo -u netdata -s ``` -- Run the `python.d.plugin` to debug the collector: +- Run the `go.d.plugin` to debug the collector: ```bash - ./python.d.plugin memcached debug trace + ./go.d.plugin -d -m memcached ``` +### Getting Logs + +If you're encountering problems with the `memcached` 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: + +```bash +journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep memcached +``` + +#### System without systemd + +Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name: + +```bash +grep memcached /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: + +```bash +docker logs netdata 2>&1 | grep memcached +``` + |