diff --git a/man/man5/mmv.5 b/man/man5/mmv.5 index 79e763c..2a4c9af 100644 --- a/man/man5/mmv.5 +++ b/man/man5/mmv.5 @@ -1,6 +1,7 @@ '\"! tbl | nroff \-man '\"macro stdmacro .\" +.\" Copyright (c) 2016 Red Hat. .\" Copyright (c) 2009 Max Matveev .\" Copyright (c) 2009 Aconex. All Rights Reserved. .\" @@ -101,14 +102,26 @@ Values .IP 5: String +.IP +6: +Instances in version 2 format +.IP +7: +Metrics in version 2 format +.IP +8: +Indoms in version 2 format .PP -The only mandatory sections are Metrics and Values. +The only mandatory sections are Metrics (or Metrics v2) and Values. Indoms and Instances sections only appear if there are metrics with multiple instances. String sections only appear if there are metrics with string values, or when Metrics or Indoms are defined with help text. +In v2 MMV form, metric names and instance names may also be encoded +out-of-band in string sections, providing significantly more space +than v1 MMV format for these names. .PP -The entries in the Indoms section have the following format: +The entries in the Indoms or Indoms2 sections have the following format: .TS box,center; c | c | c @@ -119,14 +132,13 @@ _ _ 4 4 Number of entries in the domain _ -8 8 Offset to first instance +8 8 Offset to first Instance or Instance2 _ 16 8 Short help text offset _ 24 8 Long help text offset .TE .PP -.PP The entries in the Instances section have the following format: .TS box,center; @@ -143,6 +155,21 @@ _ 16 64 External instance identifier .TE .PP +The entries in the Instances2 section have the following format: +.TS +box,center; +c | c | c +n | n | l. +Offset Length Value +_ +0 8 Offset into the indom section +_ +8 4 Unused padding (zero filled) +_ +12 4 Internal instance identifier +_ +16 8 External instance identifier string offset +.TE .PP The entries in the Metrics section have the following format: .TS @@ -170,6 +197,31 @@ _ 96 8 Long help text offset .TE .PP +The entries in the Metrics2 section have the following format: +.TS +box,center; +c | c | c +n | n | l. +Offset Length Value +_ +0 8 Metric Name string offset +_ +8 4 Metric Item (see \f2PMDA\f1(3)) +_ +12 4 Metric Type (see \f2mmv_stats.h\f1) +_ +16 4 Semantics (see \f2PMAPI\f1(3)) +_ +20 4 Dimensions (see \f2PMAPI\f1(3)) +_ +24 4 Instance Domain ID +_ +28 4 Unused padding (zero filled) +_ +32 8 Short help text offset +_ +40 8 Long help text offset +.TE .PP The entries in the Values section have the following format: .TS @@ -187,14 +239,13 @@ _ 24 8 Offset into the Instances section .TE .PP -.PP Each entry in the strings section is a 256 byte character array, containing a single NULL-terminated character string. So each string has a maximum length of 256 bytes, which includes the terminating NULL. -.PP .SH SEE ALSO .BR PCPIntro (1), +.BR pmdammv (1), .BR PMAPI (3), .BR mmv_stats_init (3), .BR pcp.conf (5)