forked from docs/docsportal
fixing wrong bullets in multiple places
This commit is contained in:
parent
efadfc75fd
commit
5d25748c82
@ -14,6 +14,7 @@ The authentication is centrally managed by LDAP.
|
|||||||
errors/alerts on zulip stream.
|
errors/alerts on zulip stream.
|
||||||
- Alerts displayed on OTC Alerta are generated either by Executor or by
|
- Alerts displayed on OTC Alerta are generated either by Executor or by
|
||||||
Grafana.
|
Grafana.
|
||||||
|
|
||||||
- “Executor alerts” focus on playbook results, whether playbook has completed or failed.
|
- “Executor alerts” focus on playbook results, whether playbook has completed or failed.
|
||||||
- “Grafana alerts” focus on breaching the defined thresholds. For example API response time is higher than defined threshold.
|
- “Grafana alerts” focus on breaching the defined thresholds. For example API response time is higher than defined threshold.
|
||||||
|
|
||||||
|
@ -57,7 +57,6 @@ Counters and timers have following subbranches:
|
|||||||
|
|
||||||
- apimon.metric → specific apimon metrics not gathered by the OpenStack API
|
- apimon.metric → specific apimon metrics not gathered by the OpenStack API
|
||||||
methods
|
methods
|
||||||
|
|
||||||
- openstack.api → pure API request metrics
|
- openstack.api → pure API request metrics
|
||||||
|
|
||||||
Every section has further following branches:
|
Every section has further following branches:
|
||||||
@ -81,13 +80,10 @@ OpenStack metrics branch is structured as following:
|
|||||||
- response code - received response code
|
- 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/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,*})
|
- 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)
|
- attempted - counter for the attempted requests (only for counters)
|
||||||
|
|
||||||
- failed - counter of failed requests (not received response, connection problems, etc) (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)
|
- passed - counter of requests receiving any response back (only for counters)
|
||||||
|
|
||||||
|
|
||||||
@ -106,15 +102,10 @@ apimon.metric
|
|||||||
|
|
||||||
|
|
||||||
- stats.timers.apimon.metric.$environment.$zone.**csm_lb_timings**.{public,private}.{http,https,tcp}.$az.__VALUE__ - timer values for the loadbalancer 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.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.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.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.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.counters.apimon.metric.$environment.$zone.**dns**.$ns_name.$host.{attempted,passed,failed} - counter values for the NS lookup test
|
||||||
|
|
||||||
|
|
||||||
|
@ -6,14 +6,16 @@ Logs
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
- Every single job run log is stored on OpenStack Swift object storage.
|
- Every single job run log is stored on OpenStack Swift object storage.
|
||||||
- Each single job log file provides unique URL which can be accessed to see log
|
- Each single job log file provides unique URL which can be accessed to see log
|
||||||
details
|
details
|
||||||
- These URLs are available on all APIMON levels:
|
- These URLs are available on all APIMON levels:
|
||||||
|
|
||||||
- In Zulip alarm messages
|
- In Zulip alarm messages
|
||||||
- In Alerta events
|
- In Alerta events
|
||||||
- In Grafana Dashboards
|
- In Grafana Dashboards
|
||||||
- Logs are simple plain text files of the whole playbook output::
|
|
||||||
|
- Logs are simple plain text files of the whole playbook output::
|
||||||
|
|
||||||
2020-07-12 05:54:04.661170 | TASK [List Servers]
|
2020-07-12 05:54:04.661170 | TASK [List Servers]
|
||||||
2020-07-12 05:54:09.050491 | localhost | ok
|
2020-07-12 05:54:09.050491 | localhost | ok
|
||||||
|
@ -10,21 +10,24 @@ The ansible playbook scenarios generate metrics in two ways:
|
|||||||
libraries.** They in turn generate metrics about each API call they do. This
|
libraries.** They in turn generate metrics about each API call they do. This
|
||||||
requires some special configuration in the clouds.yaml file (currently
|
requires some special configuration in the clouds.yaml file (currently
|
||||||
exposing metrics into statsd and InfluxDB is supported). For details refer
|
exposing metrics into statsd and InfluxDB is supported). For details refer
|
||||||
to the [config
|
to the `config
|
||||||
documentation](https://docs.openstack.org/openstacksdk/latest/user/guides/stats.html)
|
documentation <https://docs.openstack.org/openstacksdk/latest/user/guides/stats.html>`_
|
||||||
of the OpenStack SDK. The following metrics are captured:
|
of the OpenStack SDK. The following metrics are captured:
|
||||||
|
|
||||||
- response HTTP code
|
- response HTTP code
|
||||||
- duration of API call
|
- duration of API call
|
||||||
- name of API call
|
- name of API call
|
||||||
- method of API call
|
- method of API call
|
||||||
- service type
|
- service type
|
||||||
|
|
||||||
- Ansible plugins may **expose additional metrics** (i.e. whether the overall
|
- Ansible plugins may **expose additional metrics** (i.e. whether the overall
|
||||||
scenario succeed or not) with help of [callback
|
scenario succeed or not) with help of `callback
|
||||||
plugin](https://github.com/stackmon/apimon/tree/main/apimon/ansible/callback).
|
plugin <https://github.com/stackmon/apimon/tree/main/apimon/ansible/callback>`_.
|
||||||
Since sometimes it is not sufficient to know only the timings of each API
|
Since sometimes it is not sufficient to know only the timings of each API
|
||||||
call, Ansible callbacks are utilized to report overall execution time and
|
call, Ansible callbacks are utilized to report overall execution time and
|
||||||
result (whether the scenario succeeded and how long it took). The following
|
result (whether the scenario succeeded and how long it took). The following
|
||||||
metrics are captured:
|
metrics are captured:
|
||||||
|
|
||||||
- test case
|
- test case
|
||||||
- playbook name
|
- playbook name
|
||||||
- environment
|
- environment
|
||||||
|
@ -66,7 +66,6 @@ ensure sustainability of the endless exceution of such scenarios:
|
|||||||
`Openstack.Cloud
|
`Openstack.Cloud
|
||||||
<https://docs.ansible.com/ansible/latest/collections/openstack/cloud/index.html>`_
|
<https://docs.ansible.com/ansible/latest/collections/openstack/cloud/index.html>`_
|
||||||
collections for native interaction with cloud in ansible.
|
collections for native interaction with cloud in ansible.
|
||||||
|
|
||||||
- In case there are features not supported by collection you can still use
|
- In case there are features not supported by collection you can still use
|
||||||
script module and call directly python SDK script to invoke required request
|
script module and call directly python SDK script to invoke required request
|
||||||
towards cloud
|
towards cloud
|
||||||
@ -80,7 +79,6 @@ ensure sustainability of the endless exceution of such scenarios:
|
|||||||
|
|
||||||
- Make sure that deletion / cleanup of the resources is triggered even if some
|
- Make sure that deletion / cleanup of the resources is triggered even if some
|
||||||
of the tasks in playbooks will fail
|
of the tasks in playbooks will fail
|
||||||
|
|
||||||
- Make sure that deletion / cleanup is triggered in right order
|
- Make sure that deletion / cleanup is triggered in right order
|
||||||
|
|
||||||
- **Simplicity**
|
- **Simplicity**
|
||||||
@ -92,10 +90,8 @@ ensure sustainability of the endless exceution of such scenarios:
|
|||||||
|
|
||||||
- ApiMon is not supposed to validate full service functionality. For such
|
- ApiMon is not supposed to validate full service functionality. For such
|
||||||
cases we have different team / framework within QA responsibility
|
cases we have different team / framework within QA responsibility
|
||||||
|
|
||||||
- Focus only on core functions which are critical for basic operation /
|
- Focus only on core functions which are critical for basic operation /
|
||||||
lifecycle of the service.
|
lifecycle of the service.
|
||||||
|
|
||||||
- The less functions you use the less potential failure rate you will have on
|
- The less functions you use the less potential failure rate you will have on
|
||||||
runnign scenario for whatever reasons
|
runnign scenario for whatever reasons
|
||||||
|
|
||||||
@ -103,7 +99,6 @@ ensure sustainability of the endless exceution of such scenarios:
|
|||||||
|
|
||||||
- Every single hardcoded parameter in scenario will later lead to potential
|
- Every single hardcoded parameter in scenario will later lead to potential
|
||||||
outage of the scenario's run in future when such parameter might change
|
outage of the scenario's run in future when such parameter might change
|
||||||
|
|
||||||
- Try to obtain all such parameters dynamically from the cloud directly.
|
- Try to obtain all such parameters dynamically from the cloud directly.
|
||||||
|
|
||||||
- **Special tags for combined metrics**
|
- **Special tags for combined metrics**
|
||||||
@ -112,7 +107,6 @@ ensure sustainability of the endless exceution of such scenarios:
|
|||||||
metric you can do with using tags parameter in the tasks
|
metric you can do with using tags parameter in the tasks
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Custom metrics in Test Scenarios
|
Custom metrics in Test Scenarios
|
||||||
================================
|
================================
|
||||||
|
|
||||||
@ -196,4 +190,3 @@ In following example the custom metric stores the result of multiple tasks in sp
|
|||||||
command: "ssh -o 'UserKnownHostsFile=/dev/null' -o 'StrictHostKeyChecking=no' linux@{{ server_ip }} -i ~/.ssh/{{ test_keypair_name }}.pem"
|
command: "ssh -o 'UserKnownHostsFile=/dev/null' -o 'StrictHostKeyChecking=no' linux@{{ server_ip }} -i ~/.ssh/{{ test_keypair_name }}.pem"
|
||||||
tags: ["az=default", "service=compute", "metric=create_server"]
|
tags: ["az=default", "service=compute", "metric=create_server"]
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user