Firebird trace session provider

Metadata

name:

saturnin.firebird.trace.session

description:

Firebird trace session provider microservice

classification:

firebird-trace/session

OID:

1.3.6.1.4.1.53446.1.1.0.3.4.2.1

OID name:

iso.org.dod.internet.private.enterprise.firebird.butler.platform.saturnin.micro.firebird.trace.session

UUID:

bb791ba5-32d6-5245-a46e-c7c2f649ab06

facilities:

firebird

API:

None

Usage

This microservice is a DATA PROVIDER that runs trace session on Firebird server via services and send trace output as blocks of text to output data pipe (using FBDP protocol).

Data is sent in blocks of the same size (except for the last one). The default block size is 64K.

The MIME type for the data transfer is text/plain, and may include charset and errors parameters.

Configuration

agent:

UUID: Agent identification (service UUID)

logging_id:

str: Logging ID for this component instance, see Context-based logging for details.

stop_on_close:

bool: Stop the service when pipe is closed. DEFAULT True.

pipe:

str: Data Pipe Identification (name). REQUIRED option.

pipe_address:

ZMQAddress: Data Pipe endpoint address. REQUIRED option.

pipe_mode:

SocketMode: Data Pipe Mode (bind/connect). REQUIRED option.

pipe_format:

MIME: Pipe data format specification. REQUIRED for CONNECT pipe mode.

batch_size:

int: Data batch size. See FBDP documentation for details. DEFAULT 5.

Note

Please note that this service by default sends up to 64K in single message, so either keep this parameter at low numbers, or adjust the max_chars value as well.

ready_schedule_interval:

int: READY message schedule interval in milliseconds. See FBDP documentation for details. DEFAULT 1000.

server:

str: Firebird server indetification (in driver configuration). REQUIRED option.

max_chars:

int: Max. number of characters transmitted in one message. REQUIRED option. DEFAULT 65535.

trace:

str: Trace session configuration. REQUIRED option.

session_name:

str: Trace session name

Important

• Only ‘text/plain’ MIME type is alowed for pipe_format.

• Only ‘charset’ and ‘errors’ MIME parameters are alowed for pipe_format.

Example:

[trace-session]
agent = bb791ba5-32d6-5245-a46e-c7c2f649ab06
pipe = pipe-1
pipe_address = inproc://${pipe}
pipe_mode = bind
pipe_format = text/plain;charset=utf-8
server = local
session_name = trace-test
database = %[\\/]employee.fdb
  {
  enabled = true
  log_statement_finish = true
  print_plan = true
  include_filter = %%SELECT%%
  exclude_filter = %%RDB$$%%
  time_threshold = 0
  max_sql_length = 2048
  }