diff options
Diffstat (limited to 'collectors/python.d.plugin/example')
| -rw-r--r-- | collectors/python.d.plugin/example/Makefile.inc | 13 | ||||
| l--------- | collectors/python.d.plugin/example/README.md | 1 | ||||
| -rw-r--r-- | collectors/python.d.plugin/example/example.chart.py | 51 | ||||
| -rw-r--r-- | collectors/python.d.plugin/example/example.conf | 87 | ||||
| -rw-r--r-- | collectors/python.d.plugin/example/integrations/example_collector.md | 171 | ||||
| -rw-r--r-- | collectors/python.d.plugin/example/metadata.yaml | 138 |
6 files changed, 0 insertions, 461 deletions
diff --git a/collectors/python.d.plugin/example/Makefile.inc b/collectors/python.d.plugin/example/Makefile.inc deleted file mode 100644 index 1b027d5a7..000000000 --- a/collectors/python.d.plugin/example/Makefile.inc +++ /dev/null @@ -1,13 +0,0 @@ -# SPDX-License-Identifier: GPL-3.0-or-later - -# THIS IS NOT A COMPLETE Makefile -# IT IS INCLUDED BY ITS PARENT'S Makefile.am -# IT IS REQUIRED TO REFERENCE ALL FILES RELATIVE TO THE PARENT - -# install these files -dist_python_DATA += example/example.chart.py -dist_pythonconfig_DATA += example/example.conf - -# do not install these files, but include them in the distribution -dist_noinst_DATA += example/README.md example/Makefile.inc - diff --git a/collectors/python.d.plugin/example/README.md b/collectors/python.d.plugin/example/README.md deleted file mode 120000 index 55877a99a..000000000 --- a/collectors/python.d.plugin/example/README.md +++ /dev/null @@ -1 +0,0 @@ -integrations/example_collector.md
\ No newline at end of file diff --git a/collectors/python.d.plugin/example/example.chart.py b/collectors/python.d.plugin/example/example.chart.py deleted file mode 100644 index d6c0b6658..000000000 --- a/collectors/python.d.plugin/example/example.chart.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Description: example netdata python.d module -# Author: Put your name here (your github login) -# SPDX-License-Identifier: GPL-3.0-or-later - -from random import SystemRandom - -from bases.FrameworkServices.SimpleService import SimpleService - -priority = 90000 - -ORDER = [ - 'random', -] - -CHARTS = { - 'random': { - 'options': [None, 'A random number', 'random number', 'random', 'random', 'line'], - 'lines': [ - ['random1'] - ] - } -} - - -class Service(SimpleService): - def __init__(self, configuration=None, name=None): - SimpleService.__init__(self, configuration=configuration, name=name) - self.order = ORDER - self.definitions = CHARTS - self.random = SystemRandom() - self.num_lines = self.configuration.get('num_lines', 4) - self.lower = self.configuration.get('lower', 0) - self.upper = self.configuration.get('upper', 100) - - @staticmethod - def check(): - return True - - def get_data(self): - data = dict() - - for i in range(0, self.num_lines): - dimension_id = ''.join(['random', str(i)]) - - if dimension_id not in self.charts['random']: - self.charts['random'].add_dimension([dimension_id]) - - data[dimension_id] = self.random.randint(self.lower, self.upper) - - return data diff --git a/collectors/python.d.plugin/example/example.conf b/collectors/python.d.plugin/example/example.conf deleted file mode 100644 index 31261b840..000000000 --- a/collectors/python.d.plugin/example/example.conf +++ /dev/null @@ -1,87 +0,0 @@ -# netdata python.d.plugin configuration for example -# -# This file is in YaML format. Generally the format is: -# -# name: value -# -# There are 2 sections: -# - global variables -# - one or more JOBS -# -# JOBS allow you to collect values from multiple sources. -# Each source will have its own set of charts. -# -# JOB parameters have to be indented (using spaces only, example below). - -# ---------------------------------------------------------------------- -# Global Variables -# These variables set the defaults for all JOBs, however each JOB -# may define its own, overriding the defaults. - -# update_every sets the default data collection frequency. -# If unset, the python.d.plugin default is used. -# update_every: 1 - -# priority controls the order of charts at the netdata dashboard. -# Lower numbers move the charts towards the top of the page. -# If unset, the default for python.d.plugin is used. -# priority: 60000 - -# penalty indicates whether to apply penalty to update_every in case of failures. -# Penalty will increase every 5 failed updates in a row. Maximum penalty is 10 minutes. -# penalty: yes - -# autodetection_retry sets the job re-check interval in seconds. -# The job is not deleted if check fails. -# Attempts to start the job are made once every autodetection_retry. -# This feature is disabled by default. -# autodetection_retry: 0 - -# ---------------------------------------------------------------------- -# JOBS (data collection sources) -# -# The default JOBS share the same *name*. 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. -# -# Any number of jobs is supported. -# -# All python.d.plugin JOBS (for all its modules) support a set of -# predefined parameters. These are: -# -# job_name: -# name: myname # the JOB's name as it will appear on the dashboard -# # dashboard (by default is the job_name) -# # JOBs sharing a name are mutually exclusive -# update_every: 1 # the JOB's data collection frequency -# priority: 60000 # the JOB's order on the dashboard -# penalty: yes # the JOB's penalty -# autodetection_retry: 0 # the JOB's re-check interval in seconds -# -# Additionally to the above, example also supports the following: -# -# num_lines: 4 # the number of lines to create -# lower: 0 # the lower bound of numbers to randomly sample from -# upper: 100 # the upper bound of numbers to randomly sample from -# -# ---------------------------------------------------------------------- -# AUTO-DETECTION JOBS - -four_lines: - name: "Four Lines" # the JOB's name as it will appear on the dashboard - update_every: 1 # the JOB's data collection frequency - priority: 60000 # the JOB's order on the dashboard - penalty: yes # the JOB's penalty - autodetection_retry: 0 # the JOB's re-check interval in seconds - num_lines: 4 # the number of lines to create - lower: 0 # the lower bound of numbers to randomly sample from - upper: 100 # the upper bound of numbers to randomly sample from - -# if you wanted to make another job to run in addition to the one above then -# you would just uncomment the job configuration below. -# two_lines: -# name: "Two Lines" # the JOB's name as it will appear on the dashboard -# num_lines: 2 # the number of lines to create -# lower: 50 # the lower bound of numbers to randomly sample from -# upper: 75 # the upper bound of numbers to randomly sample from diff --git a/collectors/python.d.plugin/example/integrations/example_collector.md b/collectors/python.d.plugin/example/integrations/example_collector.md deleted file mode 100644 index 7dded67ba..000000000 --- a/collectors/python.d.plugin/example/integrations/example_collector.md +++ /dev/null @@ -1,171 +0,0 @@ -<!--startmeta -custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/example/README.md" -meta_yaml: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/example/metadata.yaml" -sidebar_label: "Example collector" -learn_status: "Published" -learn_rel_path: "Data Collection/Other" -most_popular: False -message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" -endmeta--> - -# Example collector - -Plugin: python.d.plugin -Module: example - -<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> - -## Overview - -Example collector that generates some random numbers as metrics. - -If you want to write your own collector, read our [writing a new Python module](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#how-to-write-a-new-module) tutorial. - - -The `get_data()` function uses `random.randint()` to generate a random number which will be collected as a metric. - - -This collector is supported on all platforms. - -This collector supports collecting metrics from multiple instances of this integration, including remote instances. - - -### Default Behavior - -#### Auto-Detection - -This integration doesn't support auto-detection. - -#### 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 Example collector instance - -These metrics refer to the entire monitored application. - - -This scope has no labels. - -Metrics: - -| Metric | Dimensions | Unit | -|:------|:----------|:----| -| example.random | random | number | - - - -## Alerts - -There are no alerts configured by default for this integration. - - -## Setup - -### Prerequisites - -No action required. - -### Configuration - -#### File - -The configuration file name for this integration is `python.d/example.conf`. - - -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). - -```bash -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata -sudo ./edit-config python.d/example.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. - - -<details><summary>Config options</summary> - -| Name | Description | Default | Required | -|:----|:-----------|:-------|:--------:| -| num_lines | The number of lines to create. | 4 | no | -| lower | The lower bound of numbers to randomly sample from. | 0 | no | -| upper | The upper bound of numbers to randomly sample from. | 100 | no | -| update_every | Sets the default data collection frequency. | 1 | 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 | - -</details> - -#### Examples - -##### Basic - -A basic example configuration. - -```yaml -four_lines: - name: "Four Lines" - update_every: 1 - priority: 60000 - penalty: yes - autodetection_retry: 0 - num_lines: 4 - lower: 0 - upper: 100 - -``` - - -## Troubleshooting - -### Debug Mode - -To troubleshoot issues with the `example` collector, run the `python.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]`. - - ```bash - cd /usr/libexec/netdata/plugins.d/ - ``` - -- Switch to the `netdata` user. - - ```bash - sudo -u netdata -s - ``` - -- Run the `python.d.plugin` to debug the collector: - - ```bash - ./python.d.plugin example debug trace - ``` - - diff --git a/collectors/python.d.plugin/example/metadata.yaml b/collectors/python.d.plugin/example/metadata.yaml deleted file mode 100644 index eae84d9e1..000000000 --- a/collectors/python.d.plugin/example/metadata.yaml +++ /dev/null @@ -1,138 +0,0 @@ -plugin_name: python.d.plugin -modules: - - meta: - plugin_name: python.d.plugin - module_name: example - monitored_instance: - name: Example collector - link: https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/example/README.md - categories: - - data-collection.other - icon_filename: "" - related_resources: - integrations: - list: [] - info_provided_to_referring_integrations: - description: "" - keywords: - - example - - netdata - - python - most_popular: false - overview: - data_collection: - metrics_description: | - Example collector that generates some random numbers as metrics. - - If you want to write your own collector, read our [writing a new Python module](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md#how-to-write-a-new-module) tutorial. - method_description: | - The `get_data()` function uses `random.randint()` to generate a random number which will be collected as a metric. - supported_platforms: - include: [] - exclude: [] - multi_instance: true - additional_permissions: - description: "" - default_behavior: - auto_detection: - description: "" - limits: - description: "" - performance_impact: - description: "" - setup: - prerequisites: - list: [] - configuration: - file: - name: python.d/example.conf - description: "" - options: - description: | - 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. - folding: - title: Config options - enabled: true - list: - - name: num_lines - description: The number of lines to create. - default_value: 4 - required: false - - name: lower - description: The lower bound of numbers to randomly sample from. - default_value: 0 - required: false - - name: upper - description: The upper bound of numbers to randomly sample from. - default_value: 100 - required: false - - name: update_every - description: Sets the default data collection frequency. - default_value: 1 - required: false - - name: priority - description: Controls the order of charts at the netdata dashboard. - default_value: 60000 - required: false - - name: autodetection_retry - description: Sets the job re-check interval in seconds. - default_value: 0 - required: false - - name: penalty - description: Indicates whether to apply penalty to update_every in case of failures. - default_value: yes - required: false - - name: name - description: 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. - default_value: "" - required: false - examples: - folding: - enabled: true - title: Config - list: - - name: Basic - folding: - enabled: false - description: A basic example configuration. - config: | - four_lines: - name: "Four Lines" - update_every: 1 - priority: 60000 - penalty: yes - autodetection_retry: 0 - num_lines: 4 - lower: 0 - upper: 100 - troubleshooting: - problems: - list: [] - alerts: [] - metrics: - folding: - title: Metrics - enabled: false - description: "" - availability: [] - scopes: - - name: global - description: | - These metrics refer to the entire monitored application. - labels: [] - metrics: - - name: example.random - description: A random number - unit: number - chart_type: line - dimensions: - - name: random |