Monitoring¶
Data for monitoring¶
There are two types of events that are monitored: request (all requests) and error (failed requests only).
Every event is a point in the time series. The point is represented using the following data:
series name (e.g. requests and errors)
start request time (timestamp of the request start)
- The tag is an indexed data in storage. It is represented as a dictionary, where
keys - string tag names,
values - string, integer or float.
- The field is a non-indexed data in storage. It is represented as a dictionary, where
keys - string field names,
values - string, integer or float.
‘Requests’ series. Saving data for ‘Requests’ is triggered on every request. Each point contains data about the corresponding request (execution time and etc.).
tags
tag name
description
service
always “luna-licenses”
route
concatenation of a request method and a request resource (GET:/version)
status_code
HTTP status code of response
fields
fields
description
request_id
request ID
execution_time
request execution time
‘Errors’ series. Saving data for ‘Errors’ is triggered when a request fails. Each point contains error_code of LUNA error.
tags
tag name
description
service
always “luna-licenses”
route
concatenation of a request method and a request resource (GET:/version)
status_code
HTTP status code of response
error_code
LUNA error code
fields
fields
description
request_id
request ID
Every handler can add additional tags or fields.
‘Licensing’ series. Triggered on license check when starting the service as well as scheduled daily at midnight. Each point contains license check data.
tags
tag name
description
service
always “luna-licenses”
license_status
license status (“ok”, “warning”, “error”)
fields
fields
description
license_period_rest
number of days before the license expires
warnings
license warning messages
errors
license error messages
Database¶
Monitoring is implemented as data sending to an influx database. You can specify your database credentials in configuration file in section “monitoring”.
Classes¶
Module contains points for monitoring’s.
- class luna_licenses.crutches_on_wheels.monitoring.points.BaseMonitoringPoint(eventTime)[source]¶
Abstract class for points
- eventTime¶
event time as timestamp
- Type
float
- abstract property fields: Dict[str, Union[int, float, str]]¶
Get tags from point. We supposed that fields are not indexing data
- Returns
dict with fields.
- Return type
Dict[str,Union[int,float,str]]
- abstract property tags: Dict[str, Union[int, float, str]]¶
Get tags from point. We supposed that tags are indexing data
- Returns
dict with tags.
- Return type
Dict[str,Union[int,float,str]]
- class luna_licenses.crutches_on_wheels.monitoring.points.BaseRequestMonitoringPoint(requestId, resource, method, requestTime, service, statusCode)[source]¶
Base class for point which is associated with requests.
- requestId¶
request id
- Type
str
- route¶
concatenation of a request method and a request resource
- Type
str
- service¶
service name
- Type
str
- requestTime¶
a request processing start timestamp
- Type
float
- statusCode¶
status code of a request response.
- Type
int
- property fields: Dict[str, Union[int, float, str]]¶
Get fields
- Returns
“request_id”
- Return type
dict with following keys
- Return type
Dict[str,Union[int,float,str]]
- property tags: Dict[str, Union[int, float, str]]¶
Get tags
- Returns
“route”, “service”, “status_code”
- Return type
dict with following keys
- Return type
Dict[str,Union[int,float,str]]
- class luna_licenses.crutches_on_wheels.monitoring.points.DataForMonitoring(tags=<factory>, fields=<factory>)[source]¶
Class fo storing an additional data for monitoring.
- class luna_licenses.crutches_on_wheels.monitoring.points.RequestErrorMonitoringPoint(requestId, resource, method, errorCode, service, requestTime, statusCode, additionalTags=None, additionalFields=None)[source]¶
Request monitoring point is suspended for monitoring requests errors (error codes)
- errorCode¶
error code
- Type
int
- additionalTags¶
additional tags which was specified for the request
- Type
dict
- additionalFields¶
additional fields which was specified for the request
- Type
dict
- property fields: Dict[str, Union[int, float, str]]¶
Get fields.
- Returns
dict with base fields and additional tags
- Return type
Dict[str,Union[int,float,str]]
- series: str = 'errors'¶
series “errors”
- property tags: Dict[str, Union[int, float, str]]¶
Get tags.
- Returns
dict with base tags, “error_code” and additional tags
- Return type
Dict[str,Union[int,float,str]]
- class luna_licenses.crutches_on_wheels.monitoring.points.RequestMonitoringPoint(requestId, resource, method, executionTime, requestTime, service, statusCode, additionalTags=None, additionalFields=None)[source]¶
Request monitoring point is suspended for monitoring all requests and measure a request time and etc.
- executionTime¶
execution time
- Type
float
- additionalTags¶
additional tags which was specified for the request
- Type
dict
- additionalFields¶
additional fields which was specified for the request
- Type
dict
- property fields: Dict[str, Union[int, float, str]]¶
Get fields.
- Returns
dict with base fields, “execution_time” and additional tags
- Return type
Dict[str,Union[int,float,str]]
- series: str = 'requests'¶
series “request”
- property tags: Dict[str, Union[int, float, str]]¶
Get tags.
- Returns
dict with base tags and additional tags
- Return type
Dict[str,Union[int,float,str]]
- luna_licenses.crutches_on_wheels.monitoring.points.getRoute(resource, method)[source]¶
Get a request route, concatenation of a request method and a request resource :param resource: resource :param method: method
- Returns
{resource}”
- Return type
“{method}
- Return type
str
- luna_licenses.crutches_on_wheels.monitoring.points.monitorTime(monitoringData, fieldName)[source]¶
Context manager for timing execution time.
- Parameters
monitoringData – container for saving result
fieldName – field name
Module implement base class for monitoring
- class luna_licenses.crutches_on_wheels.monitoring.base_monitoring.BaseLunaMonitoring[source]¶
Base class for monitoring
- class luna_licenses.crutches_on_wheels.monitoring.base_monitoring.LunaRequestInfluxMonitoring(credentials, host='localhost', port=8086, ssl=False, flushingPeriod=1)[source]¶
Class for sending data which is associated with request to influx .. attribute:: settings
influxdb settings
- type
InfluxSettings
- flushingPeriod¶
period of flushing points (in seconds)
- Type
int
Module contains classes for sending a data to an influx monitoring.
- class luna_licenses.crutches_on_wheels.monitoring.influx_adapter.BaseMonitoringAdapter(settings, flushingPeriod)[source]¶
Base monitoring adapter.
- client¶
influx client
- Type
InfluxDBClient
- backgroundScheduler¶
runner for periodic flushing monitoring points
- Type
AsyncIOScheduler
- _buffer¶
list of buffering points which is waiting sending to influx
- Type
- flushingPeriod¶
period of flushing points (in seconds)
- Type
float
- _influxSettings¶
current influx settings
- Type
- _job¶
sending monitoring data job
- Type
Job
- addPointsToBuffer(points)[source]¶
Add points to buffer.
- Parameters
points – points
- Return type
None
- static convertPointToDict(point)[source]¶
Convert point to influx client point :param point: point
- Returns
‘time’ - timestamp in nanoseconds
’measurement’ - time series
’tags’ - dict of tags (values are str)
’fields’ - dict of fields
- Return type
dict
- Return type
dict
- class luna_licenses.crutches_on_wheels.monitoring.influx_adapter.InfluxMonitoringAdapter(settings, flushingPeriod)[source]¶
Influx 2.x adaptor. Suspended to send points to an influxdb
- client¶
influx 2.x client
- Type
InfluxDBClient
- bucket¶
influx bucket name
- Type
str