← Back to branch summary

~ubuntu-branches/ubuntu/vivid/ceilometer/vivid

« back to all changes in this revision

Viewing changes to doc/source/measurements.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2014-03-06 14:44:28 UTC
  • mto: (28.1.1 utopic-proposed) (1.2.1)
  • mto: This revision was merged to the branch mainline in revision 19.
  • Revision ID: package-import@ubuntu.com-20140306144428-rvphsh4igwyulzf0
Tags: upstream-2014.1~b3
Import upstream version 2014.1~b3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/measurements.rst
54
54
Dimension     Unit      Abbreviations   Note
55
55
============  ========  ==============  =====
56
56
None          N/A                       Dimension-less variable
57
 
Volume        byte                   B
58
 
Time          seconds                s
 
57
Volume        byte      B
 
58
Time          seconds   s
59
59
============  ========  ==============  =====
60
60
 
61
61
Here are the meter types by components that are currently implemented:
65
65
 
66
66
All meters are related to the guest machine, not the host.
67
67
 
68
 
========================  ==========  ========  ========  ============  =======================================================
69
 
Name                      Type        Unit      Resource  Origin        Note
70
 
========================  ==========  ========  ========  ============  =======================================================
71
 
instance                  Gauge       instance  inst ID   both          Duration of instance
72
 
instance:<type>           Gauge       instance  inst ID   both          Duration of instance <type> (openstack types)
73
 
memory                    Gauge             MB  inst ID   notification  Volume of RAM in MB
74
 
cpu                       Cumulative        ns  inst ID   pollster      CPU time used
75
 
cpu_util                  Gauge              %  inst ID   pollster      Average CPU utilisation
76
 
vcpus                     Gauge           vcpu  inst ID   notification  Number of VCPUs
77
 
disk.read.requests        Cumulative   request  inst ID   pollster      Number of read requests
78
 
disk.write.requests       Cumulative   request  inst ID   pollster      Number of write requests
79
 
disk.read.bytes           Cumulative         B  inst ID   pollster      Volume of read in B
80
 
disk.write.bytes          Cumulative         B  inst ID   pollster      Volume of write in B
81
 
disk.root.size            Gauge             GB  inst ID   notification  Size of root disk in GB
82
 
disk.ephemeral.size       Gauge             GB  inst ID   notification  Size of ephemeral disk in GB
83
 
network.incoming.bytes    Cumulative         B  iface ID  pollster      number of incoming bytes on the network for a VM interface
84
 
network.outgoing.bytes    Cumulative         B  iface ID  pollster      number of outgoing bytes on the network for a VM interface
85
 
network.incoming.packets  Cumulative    packet  iface ID  pollster      number of incoming packets for a VM interface
86
 
network.outgoing.packets  Cumulative    packet  iface ID  pollster      number of outgoing packets for a VM interface
87
 
========================  ==========  ========  ========  ============  =======================================================
 
68
=============================  ==========  =========  ========  ============  ==================================================================
 
69
Name                           Type        Unit       Resource  Origin        Note
 
70
=============================  ==========  =========  ========  ============  ==================================================================
 
71
instance                       Gauge       instance   inst ID   both          Existence of instance
 
72
instance:<type>                Gauge       instance   inst ID   both          Existence of instance <type> (openstack types)
 
73
memory                         Gauge       MB         inst ID   notification  Volume of RAM in MB
 
74
cpu                            Cumulative  ns         inst ID   pollster      CPU time used
 
75
cpu_util                       Gauge       %          inst ID   pollster      Average CPU utilisation
 
76
vcpus                          Gauge       vcpu       inst ID   notification  Number of VCPUs
 
77
disk.read.requests             Cumulative  request    inst ID   pollster      Number of read requests
 
78
disk.read.requests.rate        Gauge       request/s  inst ID   pollster      Average rate of read requests per second
 
79
disk.write.requests            Cumulative  request    inst ID   pollster      Number of write requests
 
80
disk.write.requests.rate       Cumulative  request/s  inst ID   pollster      Average rate of write requests per second
 
81
disk.read.bytes                Cumulative  B          inst ID   pollster      Volume of reads in B
 
82
disk.read.bytes.rate           Cumulative  B/s        inst ID   pollster      Average rate of reads in B per second
 
83
disk.write.bytes               Cumulative  B          inst ID   pollster      Volume of writes in B
 
84
disk.write.bytes.rate          Cumulative  B/s        inst ID   pollster      Average volume of writes in B per second
 
85
disk.root.size                 Gauge       GB         inst ID   notification  Size of root disk in GB
 
86
disk.ephemeral.size            Gauge       GB         inst ID   notification  Size of ephemeral disk in GB
 
87
network.incoming.bytes         Cumulative  B          iface ID  pollster      Number of incoming bytes on a VM network interface
 
88
network.incoming.bytes.rate    Gauge       B/s        iface ID  pollster      Average rate per sec of incoming bytes on a VM network interface
 
89
network.outgoing.bytes         Cumulative  B          iface ID  pollster      Number of outgoing bytes on a VM network interface
 
90
network.outgoing.bytes.rate    Gauge       B/s        iface ID  pollster      Average rate per sec of outgoing bytes on a VM network interface
 
91
network.incoming.packets       Cumulative  packet     iface ID  pollster      Number of incoming packets on a VM network interface
 
92
network.incoming.packets.rate  Gauge       packet/s   iface ID  pollster      Average rate per sec of incoming packets on a VM network interface
 
93
network.outgoing.packets       Cumulative  packet     iface ID  pollster      Number of outgoing packets on a VM network interface
 
94
network.outgoing.packets.rate  Gauge       packet/s   iface ID  pollster      Average rate per sec of outgoing packets on a VM network interface
 
95
=============================  ==========  =========  ========  ============  ==================================================================
88
96
 
89
97
At present, most of the Nova meters will only work with libvirt front-end
90
98
hypervisors while test coverage was mostly done based on KVM. Contributors
91
 
are welcome to implement other virtualization backends’ meters or complete
 
99
are welcome to implement other virtualization backends' meters or complete
92
100
the existing ones.
93
101
 
94
102
Network (Neutron)
97
105
========================  ==========  ========  ========  ============  ======================================================
98
106
Name                      Type        Unit      Resource  Origin        Note
99
107
========================  ==========  ========  ========  ============  ======================================================
100
 
network                   Gauge       network   netw ID   notification  Duration of network
 
108
network                   Gauge       network   netw ID   notification  Existence of network
101
109
network.create            Delta       network   netw ID   notification  Creation requests for this network
102
110
network.update            Delta       network   netw ID   notification  Update requests for this network
103
 
subnet                    Gauge       subnet    subnt ID  notification  Duration of subnet
 
111
subnet                    Gauge       subnet    subnt ID  notification  Existence of subnet
104
112
subnet.create             Delta       subnet    subnt ID  notification  Creation requests for this subnet
105
113
subnet.update             Delta       subnet    subnt ID  notification  Update requests for this subnet
106
 
port                      Gauge       port      port ID   notification  Duration of port
 
114
port                      Gauge       port      port ID   notification  Existence of port
107
115
port.create               Delta       port      port ID   notification  Creation requests for this port
108
116
port.update               Delta       port      port ID   notification  Update requests for this port
109
 
router                    Gauge       router    rtr ID    notification  Duration of router
 
117
router                    Gauge       router    rtr ID    notification  Existence of router
110
118
router.create             Delta       router    rtr ID    notification  Creation requests for this router
111
119
router.update             Delta       router    rtr ID    notification  Update requests for this router
112
 
ip.floating               Gauge       ip        ip ID     both          Duration of floating ip
 
120
ip.floating               Gauge       ip        ip ID     both          Existence of floating ip
113
121
ip.floating.create        Delta       ip        ip ID     notification  Creation requests for this floating ip
114
122
ip.floating.update        Delta       ip        ip ID     notification  Update requests for this floating ip
115
123
========================  ==========  ========  ========  ============  ======================================================
120
128
========================  ==========  =======  ========  ============  =======================================================
121
129
Name                      Type        Unit     Resource  Origin        Note
122
130
========================  ==========  =======  ========  ============  =======================================================
123
 
image                     Gauge         image  image ID  both          Image polling -> it (still) exists
124
 
image.size                Gauge             B  image ID  both          Uploaded image size
125
 
image.update              Delta         image  image ID  notification  Number of update on the image
126
 
image.upload              Delta         image  image ID  notification  Number of upload of the image
127
 
image.delete              Delta         image  image ID  notification  Number of delete on the image
128
 
image.download            Delta             B  image ID  notification  Image is downloaded
129
 
image.serve               Delta             B  image ID  notification  Image is served out
 
131
image                     Gauge       image    image ID  both          Image polling -> it (still) exists
 
132
image.size                Gauge       B        image ID  both          Uploaded image size
 
133
image.update              Delta       image    image ID  notification  Number of update on the image
 
134
image.upload              Delta       image    image ID  notification  Number of upload of the image
 
135
image.delete              Delta       image    image ID  notification  Number of delete on the image
 
136
image.download            Delta       B        image ID  notification  Image is downloaded
 
137
image.serve               Delta       B        image ID  notification  Image is served out
130
138
========================  ==========  =======  ========  ============  =======================================================
131
139
 
132
140
Volume (Cinder)
135
143
========================  ==========  =======  ========  ============  =======================================================
136
144
Name                      Type        Unit     Resource  Origin        Note
137
145
========================  ==========  =======  ========  ============  =======================================================
138
 
volume                    Gauge        volume  vol ID    notification  Duration of volume
139
 
volume.size               Gauge            GB  vol ID    notification  Size of volume
 
146
volume                    Gauge       volume   vol ID    notification  Existence of volume
 
147
volume.size               Gauge       GB       vol ID    notification  Size of volume
140
148
========================  ==========  =======  ========  ============  =======================================================
141
149
 
142
150
Make sure Cinder is properly configured first: see :ref:`installing_manually`.
145
153
======================
146
154
 
147
155
===============================  ==========  ==========  ===========  ============  ==========================================
148
 
Name                             Type        Volume      Resource     Origin        Note
 
156
Name                             Type        Unit        Resource     Origin        Note
149
157
===============================  ==========  ==========  ===========  ============  ==========================================
150
 
storage.objects                  Gauge           object  store ID     pollster      Number of objects
151
 
storage.objects.size             Gauge                B  store ID     pollster      Total size of stored objects
152
 
storage.objects.containers       Gauge        container  store ID     pollster      Number of containers
153
 
storage.objects.incoming.bytes   Delta                B  store ID     notification  Number of incoming bytes
154
 
storage.objects.outgoing.bytes   Delta                B  store ID     notification  Number of outgoing bytes
155
 
storage.api.request              Delta          request  store ID     notification  Number of API requests against swift
156
 
storage.containers.objects       Gauge           object  str ID/cont  pollster      Number of objects in container
157
 
storage.containers.objects.size  Gauge                B  str ID/cont  pollster      Total size of stored objects in container
 
158
storage.objects                  Gauge       object      store ID     pollster      Number of objects
 
159
storage.objects.size             Gauge       B           store ID     pollster      Total size of stored objects
 
160
storage.objects.containers       Gauge       container   store ID     pollster      Number of containers
 
161
storage.objects.incoming.bytes   Delta       B           store ID     notification  Number of incoming bytes
 
162
storage.objects.outgoing.bytes   Delta       B           store ID     notification  Number of outgoing bytes
 
163
storage.api.request              Delta       request     store ID     notification  Number of API requests against swift
 
164
storage.containers.objects       Gauge       object      str ID/cont  pollster      Number of objects in container
 
165
storage.containers.objects.size  Gauge       B           str ID/cont  pollster      Total size of stored objects in container
158
166
===============================  ==========  ==========  ===========  ============  ==========================================
159
167
 
160
168
In order to use storage.objects.incoming.bytes and storage.outgoing.bytes, one must configure
162
170
updated right after an upload/download, since Swift takes some time to update
163
171
the container properties.
164
172
 
 
173
Orchestration (Heat)
 
174
====================
 
175
 
 
176
===============================  ==========  ==========  ===========  ============  ==========================================
 
177
Name                             Type        Unit        Resource     Origin        Note
 
178
===============================  ==========  ==========  ===========  ============  ==========================================
 
179
stack.create                     Delta       stack       stack ID     notification  Creation requests for a stack successful
 
180
stack.update                     Delta       stack       stack ID     notification  Updating requests for a stack successful
 
181
stack.delete                     Delta       stack       stack ID     notification  Deletion requests for a stack successful
 
182
stack.resume                     Delta       stack       stack ID     notification  Resuming requests for a stack successful
 
183
stack.suspend                    Delta       stack       stack ID     notification  Suspending requests for a stack successful
 
184
===============================  ==========  ==========  ===========  ============  ==========================================
 
185
 
 
186
To enable Heat notifications configure Heat as described in :ref:`installing_manually`.
 
187
 
165
188
Energy (Kwapi)
166
189
==============
167
190
 
168
191
==========================  ==========  ==========  ========  ========= ==============================================
169
 
Name                        Type        Volume      Resource  Origin    Note
170
 
==========================  ==========  ==========  ========  ========= ==============================================
171
 
energy                      Cumulative         kWh  probe ID  pollster  Amount of energy
172
 
power                       Gauge                W  probe ID  pollster  Power consumption
173
 
==========================  ==========  ==========  ========  ========= ==============================================
 
192
Name                        Type        Unit        Resource  Origin    Note
 
193
==========================  ==========  ==========  ========  ========= ==============================================
 
194
energy                      Cumulative  kWh         probe ID  pollster  Amount of energy
 
195
power                       Gauge       W           probe ID  pollster  Power consumption
 
196
==========================  ==========  ==========  ========  ========= ==============================================
 
197
 
 
198
Network (From SDN Controller)
 
199
=============
 
200
 
 
201
These meters based on OpenFlow Switch metrics.
 
202
In order to enable these meters, each driver needs to be configured.
 
203
 
 
204
=================================  ==========  ======  =========  ========  ==============================
 
205
Meter                              Type        Unit    Resource   Origin    Note
 
206
=================================  ==========  ======  =========  ========  ==============================
 
207
switch                             Gauge       switch  switch ID  pollster  Existence of switch
 
208
switch.port                        Gauge       port    switch ID  pollster  Existence of port
 
209
switch.port.receive.packets        Cumulative  packet  switch ID  pollster  Received Packets
 
210
switch.port.transmit.packets       Cumulative  packet  switch ID  pollster  Transmitted Packets
 
211
switch.port.receive.bytes          Cumulative  B       switch ID  pollster  Received Bytes
 
212
switch.port.transmit.bytes         Cumulative  B       switch ID  pollster  Transmitted Bytes
 
213
switch.port.receive.drops          Cumulative  packet  switch ID  pollster  Receive Drops
 
214
switch.port.transmit.drops         Cumulative  packet  switch ID  pollster  Transmit Drops
 
215
switch.port.receive.errors         Cumulative  packet  switch ID  pollster  Receive Errors
 
216
switch.port.transmit.errors        Cumulative  packet  switch ID  pollster  Transmit Errors
 
217
switch.port.receive.frame_error    Cumulative  packet  switch ID  pollster  Receive Frame Alignment Errors
 
218
switch.port.receive.overrun_error  Cumulative  packet  switch ID  pollster  Receive Overrun Errors
 
219
switch.port.receive.crc_error      Cumulative  packet  switch ID  pollster  Receive CRC Errors
 
220
switch.port.collision.count        Cumulative  count   switch ID  pollster  Collisions
 
221
switch.table                       Gauge       table   switch ID  pollster  Duration of Table
 
222
switch.table.active.entries        Gauge       entry   switch ID  pollster  Active Entries
 
223
switch.table.lookup.packets        Gauge       packet  switch ID  pollster  Packet Lookups
 
224
switch.table.matched.packets       Gauge       packet  switch ID  pollster  Packet Matches
 
225
switch.flow                        Gauge       flow    switch ID  pollster  Duration of Flow
 
226
switch.flow.duration.seconds       Gauge       s       switch ID  pollster  Duration(seconds)
 
227
switch.flow.duration.nanoseconds   Gauge       ns      switch ID  pollster  Duration(nanoseconds)
 
228
switch.flow.packets                Cumulative  packet  switch ID  pollster  Received Packets
 
229
switch.flow.bytes                  Cumulative  B       switch ID  pollster  Received Bytes
 
230
=================================  ==========  ======  =========  ========  ==============================
174
231
 
175
232
Dynamically retrieving the Meters via ceilometer client
176
233
=======================================================