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

# This collector will not appear in documentation, as the go version is preferred,
# https://github.com/netdata/go.d.plugin/blob/master/modules/nvidia_smi/README.md
#
# meta:
#   plugin_name: python.d.plugin
#   module_name: nvidia_smi
#   monitored_instance:
#     name: python.d nvidia_smi
#     link: ''
#     categories: []
#     icon_filename: ''
#   related_resources:
#     integrations:
#       list: []
#   info_provided_to_referring_integrations:
#     description: ''
#   keywords: []
#   most_popular: false
# overview:
#   data_collection:
#     metrics_description: ''
#     method_description: ''
#   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: ''
#       description: ''
#     options:
#       description: ''
#       folding:
#         title: ''
#         enabled: true
#       list: []
#     examples:
#       folding:
#         enabled: true
#         title: ''
#       list: []
# troubleshooting:
#   problems:
#     list: []
# alerts: []
# metrics:
#   folding:
#     title: Metrics
#     enabled: false
#   description: ""
#   availability: []
#   scopes:
#   - name: GPU
#     description: ""
#     labels: []
#     metrics:
#     - name: nvidia_smi.pci_bandwidth
#       description: PCI Express Bandwidth Utilization
#       unit: "KiB/s"
#       chart_type: area
#       dimensions:
#       - name: rx
#       - name: tx
#     - name: nvidia_smi.pci_bandwidth_percent
#       description: PCI Express Bandwidth Percent
#       unit: "percentage"
#       chart_type: area
#       dimensions:
#       - name: rx_percent
#       - name: tx_percent
#     - name: nvidia_smi.fan_speed
#       description: Fan Speed
#       unit: "percentage"
#       chart_type: line
#       dimensions:
#       - name: speed
#     - name: nvidia_smi.gpu_utilization
#       description: GPU Utilization
#       unit: "percentage"
#       chart_type: line
#       dimensions:
#       - name: utilization
#     - name: nvidia_smi.mem_utilization
#       description: Memory Bandwidth Utilization
#       unit: "percentage"
#       chart_type: line
#       dimensions:
#       - name: utilization
#     - name: nvidia_smi.encoder_utilization
#       description: Encoder/Decoder Utilization
#       unit: "percentage"
#       chart_type: line
#       dimensions:
#       - name: encoder
#       - name: decoder
#     - name: nvidia_smi.memory_allocated
#       description: Memory Usage
#       unit: "MiB"
#       chart_type: stacked
#       dimensions:
#       - name: free
#       - name: used
#     - name: nvidia_smi.bar1_memory_usage
#       description: Bar1 Memory Usage
#       unit: "MiB"
#       chart_type: stacked
#       dimensions:
#       - name: free
#       - name: used
#     - name: nvidia_smi.temperature
#       description: Temperature
#       unit: "celsius"
#       chart_type: line
#       dimensions:
#       - name: temp
#     - name: nvidia_smi.clocks
#       description: Clock Frequencies
#       unit: "MHz"
#       chart_type: line
#       dimensions:
#       - name: graphics
#       - name: video
#       - name: sm
#       - name: mem
#     - name: nvidia_smi.power
#       description: Power Utilization
#       unit: "Watts"
#       chart_type: line
#       dimensions:
#       - name: power
#     - name: nvidia_smi.power_state
#       description: Power State
#       unit: "state"
#       chart_type: line
#       dimensions:
#       - name: a dimension per {power_state}
#     - name: nvidia_smi.processes_mem
#       description: Memory Used by Each Process
#       unit: "MiB"
#       chart_type: stacked
#       dimensions:
#       - name: a dimension per process
#     - name: nvidia_smi.user_mem
#       description: Memory Used by Each User
#       unit: "MiB"
#       chart_type: stacked
#       dimensions:
#       - name: a dimension per user
#     - name: nvidia_smi.user_num
#       description: Number of User on GPU
#       unit: "num"
#       chart_type: line
#       dimensions:
#       - name: users