VK Cloud logo

Logging pluginBeta

Sending user application logs to the Cloud Logging service is enabled and configured via the vkcloudlogs-fluent-bit-plugin logging plugin. It works with the Golang plugin interface provided by Fluent Bit.

Plugin authorization parameters

Parameter

Required

Description

Where to find

auth_url

Logging plugin

The Keystone service endpoint

The Auth URL parameter in your VK Cloud management console

project_id

Logging plugin

An identifier of a VK Cloud project to which logs will be recorded

The Project ID parameter in your VK Cloud management console.

Example: a1b2c3d4e5f6g7h8i9a1b2c3d4e5f6g7

Do not confuse with Project Name of the form mcs1234567890

user_id

Logging plugin

An identifier of a user on whose behalf logs will be recorded

Created in your VK Cloud management console on the User credentials generation tab

user_name

Logging plugin

A login of a user on whose behalf logs will be recorded

The Username parameter in your VK Cloud management console

password

Logging plugin

The password of the user specified in user_id or user_name

For user_id, the password is created in your VK Cloud management console on the User credentials generation tab.

For user_name, the password of your VK Cloud management console is used

key_file

Logging plugin

A name of a JSON file that contains the user_id and password values

internal

Logging plugin

The parameter indicating whether the recording of technical service logs will be enabled:

  • true — enabled
  • false — disabled

By default: true

Acceptable options for specifying user credentials:

  • user_id and password;
  • key_file;
  • user_name and password (for example, your username and password to sign in to your VK Cloud management console).

Plugin configuration parameters

Parameter

Required

Description

server_host_port

Logging plugin

The Cloud Logging service address (cloudlogs.mcs.mail.ru:443)

service_id

Logging plugin

A service ID in the logging system:

  • databases — the Cloud Databases service
  • containers — the Cloud Containers service
  • vdi — the Cloud Desktop service

If not specified, the default value will be assigned.

If necessary, create your own IDs through technical support or by yourself on the Other resources tab in the settings of the Monitoring → Logging section

group_id

Logging plugin

A log group identifier. By default: a Tag parameter value assigned to an event in Fluent Bit

group_id_key

Logging plugin

A name of a parameter containing the log group identifier. Used if the group_id parameter is not specified

stream_id

Logging plugin

A log source identifier, for example: an instance ID (instance_id) or a VM ID (vm_id). By default: empty

stream_id_key

Logging plugin

A name of a parameter containing the log source identifier. Used if the stream_id parameter is not specified

message_key

Logging plugin

A name of a parameter containing a message that will be added to each log entry. By default: message

level_key

Logging plugin

A name of a parameter containing a logging level value. By default: level

default_level

Logging plugin

The logging level value. Used if there is no parameter with the name specified in level_key. By default: debug

default_payload

Logging plugin

A JSON string containing key/value pairs that will be added to the payload field of every log entry.

Example: {"tag": "example", "case": 3}

By default: an empty string

tls_on

Logging plugin

The parameter indicating whether TLS is enabled for the server_host_port address:

  • true — enabled
  • false — disabled

By default: true

tls_verify

Logging plugin

The parameter indicating whether the TLS certificate verification is enabled for the server_host_port address:

  • true — enabled
  • false — disabled

By default: true

Examples of setting up the plugin using its authorization and configuration parameters are given in the Plugin installation и Managing the logging agent sections.