netdata/collectors/python.d.plugin/tor/metadata.yaml

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: tor
      monitored_instance:
        name: Tor
        link: 'https://www.torproject.org/'
        categories:
          - data-collection.vpns
        icon_filename: 'tor.svg'
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ''
      keywords:
        - tor
        - traffic
        - vpn
      most_popular: false
    overview:
      data_collection:
        metrics_description: 'This collector monitors Tor bandwidth traffic .'
        method_description: 'It connects to the Tor control port to collect traffic statistics.'
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ''
      default_behavior:
        auto_detection:
          description: 'If no configuration is provided the collector will try to connect to 127.0.0.1:9051 to detect a running tor instance.'
        limits:
          description: ''
        performance_impact:
          description: ''
    setup:
      prerequisites:
        list:
          - title: 'Required python module'
            description: |
              The `stem` python library needs to be installed.
          - title: 'Required Tor configuration'
            description: |
              Add to /etc/tor/torrc:
              
              ControlPort 9051
              
              For more options please read the manual.
      configuration:
        file:
          name: python.d/tor.conf
        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: update_every
              description: Sets the default data collection frequency.
              default_value: 5
              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
            - name: control_addr
              description: Tor control IP address
              default_value: 127.0.0.1
              required: false
            - name: control_port
              description: Tor control port. Can be either a tcp port, or a path to a socket file.
              default_value: 9051
              required: false
            - name: password
              description: Tor control password
              default_value: ''
              required: false
        examples:
          folding:
            enabled: true
            title: "Config"
          list:
            - name: Local TCP
              description: A basic TCP configuration. `local_addr` is ommited and will default to `127.0.0.1`
              config: |
                local_tcp:
                 name: 'local'
                 control_port: 9051
                 password: <password> # if required
            - name: Local socket
              description: A basic local socket configuration
              config: |
                local_socket:
                 name: 'local'
                 control_port: '/var/run/tor/control'
                 password: <password> # if required
    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: tor.traffic
              description: Tor Traffic
              unit: "KiB/s"
              chart_type: area
              dimensions:
                - name: read
                - name: write