pmdajson(1)

1PMDAJSON(1)                 General Commands Manual                PMDAJSON(1)
2
3
4

NAME

6       pmdajson - JSON PMDA
7

DESCRIPTION

9       pmdajson  is  a  Performance  Metrics Domain Agent (PMDA) which exports
10       metrics from arbitrary sources generating  Javascript  Object  Notation
11       (JSON) syntax, describing metric metadata and values.
12
13       Further details on the JSON format can be found at http://www.json.org
14

JSON DATA SOURCES

16       pmdajson  searches  the  directories listed in the "directory_list" and
17       "trusted_directory_list" config file options, looking for files  called
18       "metadata.json".  These  JSON metadata files describe the names, types,
19       etc. of their associated JSON data. For example, let's assume the  fol‐
20       lowing simple JSON data file:
21
22         {
23           "string_value": "testing, 1, 2, 3",
24           "read_count": 0
25         }
26
27       The associated metadata file would look like the following:
28
29         {
30           "metrics": [
31             {
32               "name": "string_value",
33               "pointer": "/string_value",
34               "type": "string",
35             },
36             {
37               "name": "read_count",
38               "pointer": "/read_count",
39               "type": "integer",
40               "description": "Times values read"
41             }
42           ]
43         }
44
45       For  more  details  on  the  JSON  metadata format, see the README file
46       included with pmdajson.
47

SECURITY MODEL

49       JSON sources that come from "directory_list" config file option  aren't
50       "trusted", and any command that needs to be run to get JSON data is run
51       as user "nobody".
52
53       JSON sources that come from "trusted_directory_list" config file option
54       are  trusted,  and any command that needs to be run to get JSON data is
55       run as user "root".
56
57       For more details on security, see the README file included with  pmdaj‐
58       son.
59

INSTALLATION

61       Install the json PMDA by using the Install script as root:
62
63             # cd $PCP_PMDAS_DIR/json
64             # ./Install
65
66       To uninstall, do the following as root:
67
68             # cd $PCP_PMDAS_DIR/json
69             # ./Remove
70
71       pmdajson  is launched by pmcd(1) and should never be executed directly.
72       The Install and  Remove  scripts  notify  pmcd(1)  when  the  agent  is
73       installed or removed.
74

FILES

76       $PCP_PMDAS_DIR/json/Install
77           installation script for the pmdajson agent
78
79       $PCP_PMDAS_DIR/json/Remove
80           undo installation script for the pmdajson agent
81
82       $PCP_PMDAS_DIR/json/config.json
83           configuration file for the pmdajson agent
84
85       $PCP_LOG_DIR/pmcd/json.log
86           default log file for error messages from pmdajson
87

PCP ENVIRONMENT

89       Environment variables with the prefix PCP_ are used to parameterize the
90       file and directory names used by PCP. On each  installation,  the  file
91       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
92       $PCP_CONF variable may be used to specify an alternative  configuration
93       file, as described in pcp.conf(5).
94