temp

package
v1.32.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 9, 2024 License: MIT Imports: 8 Imported by: 10

README

Temperature Input Plugin

The temp input plugin gather metrics on system temperature. This plugin is meant to be multi platform and uses platform specific collection methods.

Currently supports Linux and Windows.

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Read metrics about temperature
[[inputs.temp]]
  ## Desired output format (Linux only)
  ## Available values are
  ##   v1 -- use pre-v1.22.4 sensor naming, e.g. coretemp_core0_input
  ##   v2 -- use v1.22.4+ sensor naming, e.g. coretemp_core_0_input
  # metric_format = "v2"

  ## Add device tag to distinguish devices with the same name (Linux only)
  # add_device_tag = false

Metrics

  • temp
    • tags:
      • sensor
    • fields:
      • temp (float, celcius)

Troubleshooting

On Windows, the plugin uses a WMI call that is can be replicated with the following command:

wmic /namespace:\\root\wmi PATH MSAcpi_ThermalZoneTemperature

If the result is "Not Supported" you may be running in a virtualized environment and not a physical machine. Additionally, if you still get this result your motherboard or system may not support querying these values. Finally, you may be required to run as admin to get the values.

Example Output

temp,sensor=coretemp_physicalid0_crit temp=100 1531298763000000000
temp,sensor=coretemp_physicalid0_critalarm temp=0 1531298763000000000
temp,sensor=coretemp_physicalid0_input temp=100 1531298763000000000
temp,sensor=coretemp_physicalid0_max temp=100 1531298763000000000

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Temperature

type Temperature struct {
	MetricFormat string          `toml:"metric_format"`
	DeviceTag    bool            `toml:"add_device_tag"`
	Log          telegraf.Logger `toml:"-"`
}

func (*Temperature) Gather

func (t *Temperature) Gather(acc telegraf.Accumulator) error

func (*Temperature) Init added in v1.29.3

func (t *Temperature) Init() error

func (*Temperature) SampleConfig

func (*Temperature) SampleConfig() string

type TemperatureStat added in v1.29.3

type TemperatureStat struct {
	Name        string
	Label       string
	Device      string
	Temperature float64
	Additional  map[string]interface{}
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL