diff --git a/doc/source/internal/apimon_training/databases.rst b/doc/source/internal/apimon_training/databases.rst index c44aab2..77f6e39 100644 --- a/doc/source/internal/apimon_training/databases.rst +++ b/doc/source/internal/apimon_training/databases.rst @@ -1,8 +1,8 @@ .. _metric_databases: -====== ========= -Metric Databases -====== ========= +================ +Metric Databases +================ Metrics are stored in 2 different database types: @@ -57,11 +57,13 @@ Counters and timers have following subbranches: - apimon.metric → specific apimon metrics not gathered by the OpenStack API methods + - openstack.api → pure API request metrics Every section has further following branches: - environment name (production_regA, production_regB, etc) + - monitoring location (production_regA, awx) - specification of the environment from which the metric is gathered @@ -93,18 +95,27 @@ apimon.metric ------------- - metric name (i.e. create_cce_cluster, delete_volume_eu-de-01, etc) - complex metrics branch + - attempted/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 -- stats.timers.apimon.metric.$environment.$zone.**csm_lb_timings**.{public,private}.{http,https,tcp}.$az.__VALUE__ - timer values for the loadbalancer test -- stats.counters.apimon.metric.$environment.$zone.**csm_lb_timings**.{public,private}.{http,https,tcp}.$az.{attempted,passed,failed} - counter values for the loadbalancer test -- stats.timers.apimon.metric.$environment.$zone.**curl**.$host.{passed,failed}.__VALUE__ - timer values for the curl test -- stats.counters.apimon.metric.$environment.$zone.**curl**.$host.{attempted,passed,failed} - counter values for the curl test -- stats.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 -- stats.counters.apimon.metric.$environment.$zone.**dns**.$ns_name.$host.{attempted,passed,failed} - counter values for the NS lookup test +- stats.timers.apimon.metric.$environment.$zone.**csm_lb_timings**.{public,private}.{http,https,tcp}.$az.__VALUE__ - timer values for the loadbalancer test + +- stats.counters.apimon.metric.$environment.$zone.**csm_lb_timings**.{public,private}.{http,https,tcp}.$az.{attempted,passed,failed} - counter values for the loadbalancer test + +- stats.timers.apimon.metric.$environment.$zone.**curl**.$host.{passed,failed}.__VALUE__ - timer values for the curl test + +- stats.counters.apimon.metric.$environment.$zone.**curl**.$host.{attempted,passed,failed} - counter values for the curl test + +- stats.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 + +- stats.counters.apimon.metric.$environment.$zone.**dns**.$ns_name.$host.{attempted,passed,failed} - counter values for the NS lookup test Postgresql diff --git a/doc/source/internal/apimon_training/metrics.rst b/doc/source/internal/apimon_training/metrics.rst index 317c4dd..c5c9866 100644 --- a/doc/source/internal/apimon_training/metrics.rst +++ b/doc/source/internal/apimon_training/metrics.rst @@ -49,3 +49,5 @@ virtual machine from deployment until succesfull login via SSH. tags: ["metric=delete_server"] tags: ["az={{ availability_zone }}", "service=compute", "metric=create_server{{ metric_suffix }}"] + +More details how to query metrics from databases are described on :ref:`Metric databases ` page.