Monitoring

Data for monitoring

Now we monitor several types of events:

  • request, all http and ws requests.

  • error, all failed http and ws requests.

  • ws requests, all messages send by websockets (ws) to clients.

  • subscription error, all errors, generated during redis messages processing or during the subscription

    establishment to redis.

  • redis messages, all messages from redis

Every event is a point in the time series. The point is represented as union of the following data:

  • series name (now requests and errors)

  • start request time

  • tags, indexed data in storage, dictionary: keys - string tag names, values - string, integer, float

  • fields, non indexed data in storage, dictionary: keys - string tag names, values - string, integer, float

‘Requests’ series. Triggered on every http or websockets request. Each point contains data about the corresponding request (execution time and etc).

  • tags

    tag name

    description

    service

    always “luna-sender”

    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. Triggered on failed http or websockets request. Each point contains error_code of luna error.

  • tags

    tag name

    description

    service

    always “luna-sender”

    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

‘Subscription errors’ series. Triggered on an error in a pipeline of processing messages from redis or redis subscription. Each point contains error_code of luna error.

  • tags

    tag name

    description

    service

    always “luna-sender”

    error_code

    luna error code

  • fields, now nothing

‘ws requests’ series. Triggered on every request by ws to a client. Each point contains a time of processing

  • tags

    tag name

    description

    service

    always “luna-sender”

    account_id

    account id or none

  • fields

    fields

    description

    transport_time

    time between getting message from redis and finish sending request to a client

    request_id

    request id

Can be to add additional tags or fields in ‘subscription_error’.

Database

Monitoring is implemented as data sending to an influx database. You can setup your database credentials in configuration file in section “monitoring”.

Classes

Points. For monitoring events in the redis context

class luna_sender.app.monitoring.points.BaseSenderMonitoringPoint(eventTime)[source]

Base point for Sender messages monitoring

classmethod initialize(serviceName)[source]

Initialize :param serviceName: service name

service: str

service name

class luna_sender.app.monitoring.points.ErrorPoint(eventTime, errorCode, additionalTags=None, additionalFields=None)[source]

Point for monitoring errors of processing messages from redis or connecting to redis

additionalTags

additional tags for point

Type

dict

errorCode

error code

Type

str

additionalFields

additional fields for point

Type

dict

property fields: dict

Get point fields

Returns

dict with additional fields

Return type

dict

series: str = 'subscription_error'

series

property tags: dict

Get point tags

Returns

dict with service as keys + additionalTags

Return type

dict

class luna_sender.app.monitoring.points.SubscribeRedisPoint(requestId, chanel, eventTime)[source]

Point for monitoring receiving message from redis

requestId

request id from luna

Type

str

chanel

redis chanel (‘{chane name}:{account id}’)

Type

str

property fields: dict

Get point fields :returns: dict with request id id as keys

Return type

dict

series: str = 'redis_message'

series

property tags: dict

Get point tags

Returns

dict with chanel and service as keys

Return type

dict

class luna_sender.app.monitoring.points.WSRequestPoint(eventTime, requestId, transportTime, accountId)[source]

Point for monitoring sending message to ws

accountId

account id

Type

str

requestId

request id from luna

Type

str

transportTime

time between getting message from redis and sending it to a ws (seconds)

Type

float

property fields: dict

Get point fields :returns: dict with request id id and transport time as keys

Return type

dict

series: str = 'ws_requests'

series

property tags: dict

Get point tags

Returns

dict with account id and service as keys

Return type

dict

Module contains points for monitoring’s.

class luna_sender.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_sender.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_sender.crutches_on_wheels.monitoring.points.DataForMonitoring(tags=<factory>, fields=<factory>)[source]

Class fo storing an additional data for monitoring.

class luna_sender.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_sender.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_sender.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_sender.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_sender.crutches_on_wheels.monitoring.base_monitoring.BaseLunaMonitoring[source]

Base class for monitoring

abstract flushPoints(points)[source]

Flush point to monitoring.

Parameters

points – point

Return type

None

class luna_sender.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

flushPoints(points)[source]

Flush point to influx.

Parameters

points – point

Return type

None

initializeMonitoring()[source]

Initialize monitoring

Return type

None

static prepareSettings(credentials, host, port, ssl)[source]

Prepare influxdb settings :param credentials: database credentials :param host: influx host :param port: influx port :param ssl: use or not ssl for connecting to influx

Returns

influxdb settings container

Return type

InfluxSettings

async stopMonitoring()[source]

Stop monitoring.

Return type

None

Module contains classes for sending a data to an influx monitoring.

class luna_sender.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

List[BaseRequestMonitoringPoint]

flushingPeriod

period of flushing points (in seconds)

Type

float

logger

logger

Type

Logger

_influxSettings

current influx settings

Type

InfluxSettings

_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

abstract static getClient(settings)[source]

Prepare influx client.

initializeScheduler()[source]

Start the loop for sending data from the buffer to monitoring.

Return type

None

stopScheduler()[source]

Stop monitoring.

Return type

None

updateFlushingPeriod(newPeriod)[source]

Update flushing period :param newPeriod: new period

class luna_sender.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

static getClient(settings)[source]

Initialize influx 2.x client. :param settings: influx 2.x settings

Returns

influx 2.0 write api

Return type

WriteApi

initializeMonitoring()[source]

Initialize monitoring.

Return type

None

stopMonitoring()[source]

Stop monitoring (cancel all request and stop getting new).

Return type

None

class luna_sender.crutches_on_wheels.monitoring.influx_adapter.InfluxSettings(url, bucket, organization, token, ssl)[source]

Container for influx 2.x settings