docsportal/doc/source/internal/apimon_training/databases.rst

Metric	Databases
Metrics	are stored in 2 different database types:
Graph	ite time series database
Postg Graphite	resql relational database
[Graphi	te](https://graphiteapp.org/) is an open-source enterprise-ready
time-se	ries database. ApiMon, EpMon, and CloudMon data are stored in the
cluster	ed Graphite TSDB. Metrics emitted by the processes are gathered in the
row of	statsd processes which aggregate metrics to 10s precision.
+-------	--------------+-----------------------------------------------------------------------------------------------+
P	arameter | Value |
+=======	==============+===============================================================================================+
Grafan	a Datasource | apimon-carbonapi |
+-------	--------------+-----------------------------------------------------------------------------------------------+
Databa	se type | time series |
+-------	--------------+-----------------------------------------------------------------------------------------------+
Main n	amespace | stats |
+-------	--------------+-----------------------------------------------------------------------------------------------+
Metric	type | OpenStack API metrics (including otcextensions) collecting response codes, latencies, methods |
	ApiMOn metrics (create_cce_cluster, delete_volume_eu-de-01, etc) |
	Custom metrics which can be created by tags in ansible playbooks |
+-------	--------------+-----------------------------------------------------------------------------------------------+
Databa	se attributes | "timers", "counters", "environment name", "monitoring location", "service", "request method", |
	"resource", "response code", "result", custom metrics, etc |
+-------	--------------+-----------------------------------------------------------------------------------------------+
result	of API calls | attempted |
	passed |
	failed |
+-------	--------------+-----------------------------------------------------------------------------------------------+
	:: training_images/graphite_query.jpg
All metr	ics are under "stats" namespace:
Under "s	tats" there are following important metric types:
- coun	ters
- time	rs
gaug	es
Counters	and timers have following subbranches:
- apim	on.metric → specific apimon metrics not gathered by the OpenStack API
meth	ods
open	stack.api → pure API request metrics
Every se	ction has further following branches:
- enviro	nment name (production_regA, production_regB, etc)
mon	itoring location (production_regA, awx) - specification of the environment from which the metric is gathered
openstac	k.api
OpenStac	k metrics branch is structured as following:
servic	e (normally service_type from the service catalog, but sometimes differs slightly)
requ	est method (GET/POST/DELETE/PUT)
r	esource (service resource, i.e. server, keypair, volume, etc). Subresources are joined with "_" (i.e. cluster_nodes) response code - received response code count/upper/lower/mean/etc - timer specific metrics (available only under stats.timers.openstack.api.$environment.$zone.$service.$request_method.$resource.$status_code.{count,mean,upper,*}) count/rate - counter specific metrics (available only under stats.counters.openstack.api.$environment.$zone.$service.$request_method.$resource.$status_code.{count,mean,upper,*}) attempted - counter for the attempted requests (only for counters) failed - counter of failed requests (not received response, connection problems, etc) (only for counters) passed - counter of requests receiving any response back (only for counters)
apimon.m	etric
- metric	name (i.e. create_cce_cluster, delete_volume_eu-de-01, etc) - complex metrics branch
att	empted/failed/failedignored/passed/skipped - counters for the corresponding operation results (this branch element represents status of the corresponding ansible task)
	$az - some metrics would have availability zone for the operation on that level. Since this info is not always available this is a varying path
- curl -	subtree for the curl type of metrics
$	name - short name of the host to be checked
- stat	s.timers.apimon.metric.$environment.$zone.csm_lb_timings.{public,private}.{http,https,tcp}.$az.__VALUE__ - timer values for the loadbalancer test
- stat	s.counters.apimon.metric.$environment.$zone.csm_lb_timings.{public,private}.{http,https,tcp}.$az.{attempted,passed,failed} - counter values for the loadbalancer test
- stat	s.timers.apimon.metric.$environment.$zone.curl.$host.{passed,failed}.__VALUE__ - timer values for the curl test
- stat	s.counters.apimon.metric.$environment.$zone.curl.$host.{attempted,passed,failed} - counter values for the curl test
- stat	s.timers.apimon.metric.$environment.$zone.dns.$ns_name.$host - timer values for the NS lookup test. $ns_name is the DNS servers used to query the records
stat	s.counters.apimon.metric.$environment.$zone.dns.$ns_name.$host.{attempted,passed,failed} - counter values for the NS lookup test
Postgres	ql

Relational database stores ApiMon playbook scenario results which provides statistics about most common service functionalities and use cases. These queries are used mainly on Test Results dashboard and Service specific statistics dashboards.

Parameter	Value
Grafana Datasource	apimon-pg
Database Type	relational
Database Table	results_summary
Metric type	apimon playbook result statistics
Database Fields	"timestamp", "name", "job_id", "result", "duration", "result_task"
result field values	0 - success 1 - ? 2 - skipped 3 - failed
result_task object parameters	"timestamp", "name", "job_id", "result", "duration", "action", "environment", "zone", "anonymized_response"