Skip to content

Log Record Schema

docs.neops.io/schema/LogRecord

One log line as stored in the backend and returned by the read API. Every value is a string except seq; keys are snake_case; fields is the only place a producer may put its own keys. Generated to schema/LogRecord.schema.json, and the OpenAPI response model of the log read routes.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated Yes Unknown status No Forbidden Forbidden none LogRecord.schema.json

Log Record Type

object (Log Record)

Log Record Properties

Property Type Required Nullable Defined by
service string Required cannot be null Log Record
env string Optional cannot be null Log Record
level string Required cannot be null Log Record
timestamp string Required cannot be null Log Record
seq integer Required cannot be null Log Record
process string Required cannot be null Log Record
message string Required cannot be null Log Record
workflow_execution_id string Optional cannot be null Log Record
workflow_id string Optional cannot be null Log Record
workflow_package string Optional cannot be null Log Record
workflow_name string Optional cannot be null Log Record
workflow_version string Optional cannot be null Log Record
step_label string Optional cannot be null Log Record
job_id string Optional cannot be null Log Record
job_type string Optional cannot be null Log Record
function_block_id string Optional cannot be null Log Record
function_block_package string Optional cannot be null Log Record
function_block_name string Optional cannot be null Log Record
function_block_version string Optional cannot be null Log Record
worker_id string Optional cannot be null Log Record
entity_type string Optional cannot be null Log Record
entity_id string Optional cannot be null Log Record
logger string Optional cannot be null Log Record
late string Optional cannot be null Log Record
event_time string Optional cannot be null Log Record
fields object Optional cannot be null Log Record

service

Which service emitted the line.

service

  • is required

  • Type: string

  • cannot be null

  • defined in: Log Record

service Type

string

service Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"neops-core"
"neops-workflow-engine"
"neops-worker"

env

Deployment label from NEOPS_LOG_ENV; omitted when empty.

env

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

env Type

string

level

level

  • is required

  • Type: string

  • cannot be null

  • defined in: Log Record

level Type

string

level Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"debug"
"info"
"warn"
"error"

timestamp

RFC 3339 with nanoseconds, event time at the producer.

timestamp

  • is required

  • Type: string

  • cannot be null

  • defined in: Log Record

timestamp Type

string

timestamp Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

seq

Producer-side ordering within one job (worker) or one process (engine, core).

seq

  • is required

  • Type: integer

  • cannot be null

  • defined in: Log Record

seq Type

integer

seq Constraints

minimum: the value of this number must greater than or equal to: 0

process

The process that assigned seq: <hostname>:<pid>:<boot> for engine and core, new on every start; the worker uuid for worker lines. Part of the total order of records.

process

  • is required

  • Type: string

  • cannot be null

  • defined in: Log Record

process Type

string

process Constraints

maximum length: the maximum number of characters for this string is: 128

message

Plain text, at most LOG_LIMITS.bytesPerMessage bytes after JSON encoding.

message

  • is required

  • Type: string

  • cannot be null

  • defined in: Log Record

message Type

string

message Constraints

maximum length: the maximum number of characters for this string is: 200000

minimum length: the minimum number of characters for this string is: 1

workflow_execution_id

workflow_execution_id

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

workflow_execution_id Type

string

workflow_execution_id Constraints

UUID: the string must be a UUID, according to RFC 4122

workflow_id

Definition id pkg/name:x.y.z.

workflow_id

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

workflow_id Type

string

workflow_package

The pkg of workflow_id.

workflow_package

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

workflow_package Type

string

workflow_name

The name of workflow_id.

workflow_name

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

workflow_name Type

string

workflow_version

The x.y.z of workflow_id.

workflow_version

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

workflow_version Type

string

step_label

step_label

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

step_label Type

string

job_id

job_id

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

job_id Type

string

job_id Constraints

UUID: the string must be a UUID, according to RFC 4122

job_type

job_type

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

job_type Type

string

job_type Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"acquire"
"execute"
"rollback"

function_block_id

pkg/name:x.y.z

function_block_id

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

function_block_id Type

string

function_block_package

The pkg of function_block_id.

function_block_package

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

function_block_package Type

string

function_block_name

The name of function_block_id.

function_block_name

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

function_block_name Type

string

function_block_version

The x.y.z of function_block_id.

function_block_version

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

function_block_version Type

string

worker_id

worker_id

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

worker_id Type

string

worker_id Constraints

UUID: the string must be a UUID, according to RFC 4122

entity_type

entity_type

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

entity_type Type

string

entity_id

entity_id

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

entity_id Type

string

logger

Engine only: the class name winston used to call context.

logger

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

logger Type

string

late

“true” on lines accepted after the job already had a result.

late

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

late Type

string

late Constraints

constant: the value of this property must be equal to:

"true"

event_time

Original timestamp when the stored one had to be clamped into Loki’s window.

event_time

  • is optional

  • Type: string

  • cannot be null

  • defined in: Log Record

event_time Type

string

fields

Producer-defined context (device_ip, platform, site, …). Keys match FIELD_KEY_PATTERN and are never in SCHEMA_RESERVED_FIELD_KEYS (the record) or RESERVED_FIELD_KEYS (a push body); values ≤ LOG_LIMITS.bytesPerFieldValue.

fields

fields Type

object (Log Fields)

fields Constraints

maximum number of properties: the maximum number of properties for this object is: 32

Log Record Definitions

Definitions group LogService

Reference this group by using

{"$ref":"docs.neops.io/schema/LogRecord#/definitions/LogService"}
Property Type Required Nullable Defined by

Definitions group LogRecordLevel

Reference this group by using

{"$ref":"docs.neops.io/schema/LogRecord#/definitions/LogRecordLevel"}
Property Type Required Nullable Defined by

Definitions group LogJobType

Reference this group by using

{"$ref":"docs.neops.io/schema/LogRecord#/definitions/LogJobType"}
Property Type Required Nullable Defined by