.. _rapl:

===========
rapl
===========

----------------------------------
Man page for the LDMS rapl plugin
----------------------------------

:Date:   18 Feb 2018
:Manual section: 7
:Manual group: LDMS sampler

SYNOPSIS
========

| Within ldmsd_controller or a configuration file:
| config name=rapl [ <attr>=<value> ]

DESCRIPTION
===========

With LDMS (Lightweight Distributed Metric Service), plugins for the
ldmsd (ldms daemon) are configured via ldmsd_controller or a
configuration file. The rapl plugin provides energy sampling using RAPL
via the PAPI interface for sandybridge.

WARNING: This sampler is unsupported.

CONFIGURATION ATTRIBUTE SYNTAX
==============================

The rapl plugin uses the sampler_base base class. This man page covers
only the configuration attributes, or those with default values,
specific to the this plugin; see :ref:`ldms_sampler_base(7) <ldms_sampler_base>` for the
attributes of the base class.

**config**
   | name=<plugin_name> [schema=<sname>]
   | configuration line

   name=<plugin_name>
      |
      | This MUST be rapl.

   schema=<schema>
      |
      | Optional schema name. It is intended that the same sampler on
        different nodes with different metrics have a different schema.
        If not specified, will default to \`rapl`.

BUGS
====

No known bugs.

NOTES
=====

-  WARNING: This is for sandybridge only.

-  This sampler is unsupported.

EXAMPLES
========

Within ldmsd_controller or a configuration file:

::

   load name=rapl
   config name=rapl producer=vm1_1 instance=vm1_1/rapl component_id=1
   start name=rapl interval=1000000

SEE ALSO
========

:ref:`ldmsd(8) <ldmsd>`, :ref:`ldms_quickstart(7) <ldms_quickstart>`, :ref:`ldmsd_controller(8) <ldmsd_controller>`, :ref:`ldms_sampler_base(7) <ldms_sampler_base>`