Skip to content

Configuration

Every key a ceres.yaml accepts. Keys are written in kebab-case, and the snake_case spelling of any multi-word key is accepted too.

Top Level

Key Accepts
service service
server server
console console
database database with type: sqlite, database with type: turso, database with type: postgres
logging logging
components components
tags list of string
access deny or view or operate or manage

service

Process-level options applied when running the engine as a system service.

Key Type Default Description
name string Service name registered with the operating system.
user string User the service runs as.
stdout string Optional path to redirect standard output to.
stderr string Optional path to redirect standard error to.

server

Configuration for the engine's HTTP server.

Key Type Default Description
bind string Address every listener binds, the WebRTC media port included, 0.0.0.0 when omitted. :: serves IPv6 and IPv4 both.
https ServerHttpsConfig HTTPS listener. The server is off when neither https nor http is set.
http ServerHttpConfig Plain HTTP listener. The server is off when neither https nor http is set.
authentication ServerAuthenticationConfig
cors ServerCorsConfig
compression ServerCompressionConfig
webrtc ServerWebRTCConfig WebRTC media port, bound beside the web listeners. Live video plays over HTTP when webrtc is not set.

ServerHttpsConfig

The HTTPS listener of the engine's HTTP server.

Key Type Default Description
port integer Port the HTTPS listener binds, 443 when omitted.
certificate auto or ServerCertificateConfig Certificate the listener presents, read from .ceres/tls/server.crt and .ceres/tls/server.key when omitted. auto has Ceres issue and renew it.
min-version 1.2 or 1.3 Lowest TLS version offered, "1.2" or "1.3", "1.2" when omitted.

ServerHttpConfig

The plain HTTP listener of the engine's HTTP server.

Key Type Default Description
port integer Port the plain HTTP listener binds, 80 when omitted.
redirect boolean Whether the listener answers every request with a temporary redirect to the same path on the HTTPS listener rather than serving it, needs https.

ServerAuthenticationConfig

Authentication settings for the engine's HTTP server.

Key Type Default Description
secret string Secret used to sign and verify authentication tokens.
duration number or string Lifetime of an issued authentication token.
allow-impersonate boolean Whether an administrator may take on another user's identity without their password.

ServerCorsConfig

Cross-origin resource sharing settings for the engine's HTTP server.

Key Type Default Description
enabled boolean
allow-origins string or list of string
allow-origin-regex string
allow-methods string or list of string
allow-headers string or list of string
allow-credentials boolean
expose-headers string or list of string
max-age integer

ServerCompressionConfig

Response compression settings for the engine's HTTP server.

Key Type Default Description
enabled boolean
min-size integer or string Minimum response size in bytes before compression is applied.
zstd boolean
zstd-level integer
brotli boolean
brotli-quality integer
gzip boolean
gzip-level integer

ServerWebRTCConfig

Live video over WebRTC, which a browser plays with less delay than the MP4 stream it falls back to.

Key Type Default Description
port integer UDP port every WebRTC session's media passes through at the server's bind address, 8189 when omitted.
hosts list of string Addresses browsers are told to reach the media port at, besides those of every interface, such as the public address of a host behind NAT.
max-sessions integer Most WebRTC sessions served at once, 32 when omitted.
no-ice-timeout number or string How long a session waits for its browser to connect before giving up its slot, 10 seconds when omitted.

ServerCertificateConfig

The certificate the HTTPS listener presents.

Key Type Default Description
path string Path to the PEM certificate chain, .ceres/tls/server.crt when omitted.
key string Path to the PEM private key, .ceres/tls/server.key when omitted.
key-password string Password for an encrypted private key, not allowed with auto.
auto boolean or ServerCertificateAutoConfig Whether Ceres issues and renews the certificate itself, true or the issuance settings. Ceres then owns both files.

ServerCertificateAutoConfig

How Ceres issues and renews the HTTPS certificate it manages.

Key Type Default Description
ip list of string IP addresses the certificate names. With dns also omitted, the certificate names localhost, 127.0.0.1, ::1, the hostname, and every non-loopback interface address.
dns list of string DNS names the certificate names. With ip also omitted, the certificate names the detected ones.
days integer Days each issued certificate stays valid, 365 when omitted and at most 825.
ca ServerCertificateAuthorityConfig Certificate authority you supply to sign the certificate, whose files must exist. When omitted, Ceres creates one at .ceres/tls/ca.crt and .ceres/tls/ca.key.

ServerCertificateAuthorityConfig

A certificate authority you supply to sign the managed HTTPS certificate.

Key Type Default Description
path string Path to the authority's PEM certificate, .ceres/tls/ca.crt when omitted. Ceres never creates it.
key string Path to the authority's PEM private key, .ceres/tls/ca.key when omitted.
key-password string Password for an encrypted authority key.

console

Branding and layout options for the engine's web console.

Key Type Default Description
title string Title shown in the console's browser tab and header.
favicon string Path to a favicon image served by the console.

database with type: sqlite

Configuration for a SQLite-backed database, the default for local deployments.

Key Type Default Description
path string Path to the SQLite file, whose directories are created. Omit to use a temporary on-disk file.
hooks DatabaseConfigHooks
engine object Extra keyword arguments forwarded to the SQLAlchemy engine factory. Values must be JSON-compatible. Anything richer than that belongs in code rather than in configuration.
hashing object or object Password hashing configuration used for users stored in this database.
query object Optional database-specific connection string query parameters.

DatabaseConfigHooks

SQL statements executed at well-known points in the database lifecycle.

Key Type Default Description
init list of string Statements run once when the database is first created.
connect list of string Statements run on every new connection.
close list of string Statements run before a connection is closed.

database with type: turso

Configuration for a Turso-backed database, a SQLite-compatible file that allows concurrent writers.

Key Type Default Description
path string Path to the database file, whose directories are created. Omit to use a temporary on-disk file.
mvcc boolean Put the database in Turso's MVCC journal mode, which lets writers overlap. This converts the database file and the conversion cannot be undone.
hooks DatabaseConfigHooks
engine object Extra keyword arguments forwarded to the SQLAlchemy engine factory. Values must be JSON-compatible. Anything richer than that belongs in code rather than in configuration.
hashing object or object Password hashing configuration used for users stored in this database.
query object Optional database-specific connection string query parameters.

database with type: postgres

Configuration for a PostgreSQL-backed database.

Key Type Default Description
host string Host the database server listens on.
port integer Port the database server listens on.
database string Name of the database to connect to.
user string User to authenticate as.
password string Password to authenticate with.
hooks DatabaseConfigHooks
engine object Extra keyword arguments forwarded to the SQLAlchemy engine factory. Values must be JSON-compatible. Anything richer than that belongs in code rather than in configuration.
hashing object or object Password hashing configuration used for users stored in this database.
query object Optional database-specific connection string query parameters.

logging

Per-component or per-engine logging configuration. output and store set minimum levels for the streamed and persisted log streams, and the toggle fields enable optional logging of specific record types.

Key Type Default Description
output debug or info or warning or error or critical Minimum severity that reaches the engine's streamed log output.
store debug or info or warning or error or critical Minimum severity persisted to the engine's log store.
events boolean or debug or info or warning or error or critical Whether to log events, or the minimum severity to log them at.
messages boolean or debug or info or warning or error or critical Whether to log raw connection messages, or the minimum severity to log them at.
particles boolean or debug or info or warning or error or critical Whether to log parsed particles, or the minimum severity to log them at.
alerts boolean or debug or info or warning or error or critical Whether to log alerts, or the minimum severity to log them at.

components

Configuration tree for a single component and any nested child components. A ComponentConfig is the unit users edit in YAML, it selects the component class to instantiate, supplies constructor arguments, and declares the component's connections, sieves, jobs, pruners, and child components.

Key Type Default Description
class string Component subclass to instantiate, defaults to the base Component class.
arguments object Keyword arguments passed to the component constructor.
tags list of string Arbitrary labels for cross-cutting permission grants.
connections list of ConnectionConfig Connections owned by this component.
sieves list of ClassSieveConfig or MethodSieveConfig Sieves owned by this component.
jobs list of JobConfig Scheduled jobs owned by this component.
pruners list of MessagePrunerConfig or ParticlePrunerConfig or AlertPrunerConfig or LogEntryPrunerConfig Pruners owned by this component.
components list of ComponentConfig Nested child component configurations.
name string required Component name, unique within its parent and used to build the component address.
logging object Per-component logging overrides, falls back to the engine config when omitted.
access deny or view or operate or manage Default access level for this component, inherited by children when not overridden.

ConnectionConfig

Configuration for a single named connection on a component. The class field selects a Connection subclass to instantiate, arguments are validated against that class's schema before instantiation so that misconfiguration surfaces at config-load time rather than at component start.

Key Type Default Description
class string Connection subclass to instantiate, defaults to the base Connection class.
arguments object Keyword arguments passed to the connection constructor.
name string required Connection name, unique within the owning component.
label string Human-readable name shown in place of name wherever the connection is listed.
description string What the connection carries.

ClassSieveConfig

Sieve configuration that instantiates a Sieve subclass directly.

Key Type Default Description
buffer-size string or integer
buffer-drop string or integer
class string required
arguments object
type string 'class'
name string required
stored boolean True
retries integer
retry-delay string 'PT5S'
filter MessageFilter

MethodSieveConfig

Sieve configuration that wraps a method on the owning component as a FunctionSieve.

Key Type Default Description
buffer-size string or integer
buffer-drop string or integer
type string 'method'
name string required
stored boolean True
retries integer
retry-delay string 'PT5S'
filter MessageFilter
method string required Name of the method on the component to wrap.
connections list of string Connections whose buffer settings should influence this sieve's buffering.

JobConfig

Configuration for a scheduled job that invokes a component action. A job names the action to call, the schedule on which to call it, and how many retries to attempt on failure. Jobs are typically declared inline in a component's configuration but can also be added at runtime via system.jobs.add.

Key Type Default Description
name string required Unique job name within the owning component.
action string required Name of the action to invoke on the component.
arguments object Keyword arguments passed to the action when it is invoked.
schedule CronSchedule or IntervalSchedule or OrSchedule required Schedule controlling when the job runs.
retries integer 0 Number of additional attempts if the action raises.
retry-delay string 'PT5S' Delay between retry attempts.

MessagePrunerConfig

Pruner configuration that periodically deletes matching Message records.

Key Type Default Description
name string required
prunes string 'message'
schedule CronSchedule or IntervalSchedule or OrSchedule required
filter MessageFilter required

ParticlePrunerConfig

Pruner configuration that periodically deletes matching Particle records.

Key Type Default Description
name string required
prunes string 'particle'
schedule CronSchedule or IntervalSchedule or OrSchedule required
filter ParticleFilter required

AlertPrunerConfig

Pruner configuration that periodically deletes matching Alert records.

Key Type Default Description
name string required
prunes string 'alert'
schedule CronSchedule or IntervalSchedule or OrSchedule required
filter AlertFilter required

LogEntryPrunerConfig

Pruner configuration that periodically deletes matching LogEntry records.

Key Type Default Description
name string required
prunes string 'log-entry'
schedule CronSchedule or IntervalSchedule or OrSchedule required
filter LogEntryFilter required

ComponentConfig

Configuration tree for a single component and any nested child components. A ComponentConfig is the unit users edit in YAML, it selects the component class to instantiate, supplies constructor arguments, and declares the component's connections, sieves, jobs, pruners, and child components.

Key Type Default Description
class string Component subclass to instantiate, defaults to the base Component class.
arguments object Keyword arguments passed to the component constructor.
tags list of string Arbitrary labels for cross-cutting permission grants.
connections list of ConnectionConfig Connections owned by this component.
sieves list of ClassSieveConfig or MethodSieveConfig Sieves owned by this component.
jobs list of JobConfig Scheduled jobs owned by this component.
pruners list of MessagePrunerConfig or ParticlePrunerConfig or AlertPrunerConfig or LogEntryPrunerConfig Pruners owned by this component.
components list of ComponentConfig Nested child component configurations.
name string required Component name, unique within its parent and used to build the component address.
logging object Per-component logging overrides, falls back to the engine config when omitted.
access deny or view or operate or manage Default access level for this component, inherited by children when not overridden.

MessageFilter

Filter for selecting Message records.

Key Type Default Description
order id or id:asc or id:desc or address or address:asc or address:desc or timestamp or timestamp:asc or timestamp:desc or connection or connection:asc or connection:desc or direction or direction:asc or direction:desc or data or data:asc or data:desc or list of id or id:asc or id:desc or address or address:asc or address:desc or timestamp or timestamp:asc or timestamp:desc or connection or connection:asc or connection:desc or direction or direction:asc or direction:desc or data or data:asc or data:desc Specify ordering of results by field. Suffix a field name with ':desc' for descending order, or with ':asc' for ascending order, which is also the default. If and__ subfilters are defined, and order is unspecified in this root order argument, the last order defined in and__ will be used instead.
limit integer Limit the number of returned results. If any and__ subfilters are defined, and any of them specify a limit which is lower than this root limit argument, the lowest defined limit value in and__ will be used instead.
offset integer Skip over a given number of results. If any and__ subfilters are defined, and any of them specify an offset which is higher than this root offset argument, the highest defined offset value in and__ will be used instead.
or MessageFilter or list of MessageFilter One or more subfilters, where in the case any match the queried value, the overall filter should match. This is a logical OR operation, and can be added to using the | operator. If both or__ and and__ are defined within the same filter object, and__ is evaluated first, meaning whether or not all conditions in and__ are matched, if any condition in or__ is matched, the overall filter will match.
and MessageFilter or list of MessageFilter One or more subfilters, where in the case all of them they match the queried value, the overall filter should match. This is a logical AND operation, and can be added to using the & operator. If both or__ and and__ are defined within the same filter object, and__ is evaluated first, meaning whether or not all conditions in and__ are matched, if any condition in or__ is matched, the overall filter will match.
id string or list of string Filter by id being equal to one or more given UUIDs.
address any Filter by address matching one or more address selectors.
root any The address which relative address selectors in address are relative to, None means all components.
timestamp string or list of string Filter by timestamp being exactly equal to one or more given datetimes.
after string Filter by timestamp being greater than or equal to a given datetime.
before string Filter by timestamp being less than a given datetime.
timespan string Filter by maximum age relative to after, or minimum age relative to before if after is None. If both after and before are None, filter by maximum age relative to the current time.
min-age string Filter by the age of timestamp, relative to the current time, being greater than or equal to a given threshold.
max-age string Filter by the age of timestamp, relative to the current time, being less than a given threshold.
after-hour integer Filter by the hour value of timestamp being greater than or equal to a given value.
before-hour integer Filter by the hour value of timestamp being less than a given value.
after-minute integer Filter by the minute value of timestamp being greater than or equal to a given value.
before-minute integer Filter by the minute of timestamp being less than a given value.
subsample-every string Subsample results, selecting at most one record per this interval of time. For example, setting timespan to 1 hour and subsample_every to 1 minute will select one record per minute for the last hour, with the total number of time buckets, meaning possible samples, being equal 60.
subsample integer Subsample results, selecting at most one record per subsample divisions of the total time range specified by this filter. To use subsample, a clear start and end to the filtered time range must be specified using some combination of time range filter fields, including: after, before, timespan, min_age, and/or max_age. For example, setting timespan to 1 hour and subsample to 60 will select one record per minute for the last hour, with the total number of time buckets, meaning possible samples, being equal to 60.
subsample-select first or last Specify which record to choose per subsampled time bucket specified by subsample_every and subsample. If unspecified or None, this will default to SubsampleSelect.FIRST.
connection string or list of string Filter by connection being equal to one or more given connections.
connection-contains string or list of string Filter by connection containing one or more given substrings.
connection-prefix string or list of string Filter by connection starting with one or more given prefixes.
connection-suffix string or list of string Filter by connection ending with one or more given suffixes.
direction send or receive or list of send or receive Filter by direction being equal to one or more given values.
data string or list of string Filter by data being equal to one or more given byte sequences.
contains string or list of string Filter by data containing one or more given byte substrings.
prefix string or list of string Filter by data starting with one or more given byte prefixes.
suffix string or list of string Filter by data ending with one or more given byte suffixes.

CronSchedule

Schedule defined by a standard crontab expression.

Key Type Default Description
type string 'cron' Schedule type discriminator, always ScheduleType.CRON.
crontab string required Crontab expression controlling when the schedule fires.

IntervalSchedule

Schedule that fires on a fixed interval with optional exponential backoff and bounds.

Key Type Default Description
type string 'interval' Schedule type discriminator, always ScheduleType.INTERVAL.
interval string required Base delay between fires, with sub-second resolution disallowed.
start string Earliest time the schedule is allowed to fire, defaults to the current time.
end string Latest time the schedule is allowed to fire, unbounded when None.
multiplier number 1 Multiplicative growth factor applied to successive intervals, 1 leaves them unchanged.
min string Lower bound on the effective interval after scaling, must be <= interval.
max string Upper bound on the effective interval after scaling, must be >= interval.

OrSchedule

Composite schedule that fires whenever any of its child schedules fires.

Key Type Default Description
type string 'or' Schedule type discriminator, always ScheduleType.OR.
schedules list of CronSchedule or IntervalSchedule or OrSchedule required Child schedules whose fire times are unioned together.

ParticleFilter

Filter for selecting particles by class, type discriminator, or JSON data content.

Key Type Default Description
order id or id:asc or id:desc or address or address:asc or address:desc or timestamp or timestamp:asc or timestamp:desc or connection or connection:asc or connection:desc or type or type:asc or type:desc or list of id or id:asc or id:desc or address or address:asc or address:desc or timestamp or timestamp:asc or timestamp:desc or connection or connection:asc or connection:desc or type or type:asc or type:desc Specify ordering of results by field. Suffix a field name with ':desc' for descending order, or with ':asc' for ascending order, which is also the default. If and__ subfilters are defined, and order is unspecified in this root order argument, the last order defined in and__ will be used instead.
limit integer Limit the number of returned results. If any and__ subfilters are defined, and any of them specify a limit which is lower than this root limit argument, the lowest defined limit value in and__ will be used instead.
offset integer Skip over a given number of results. If any and__ subfilters are defined, and any of them specify an offset which is higher than this root offset argument, the highest defined offset value in and__ will be used instead.
or ParticleFilter or list of ParticleFilter One or more subfilters, where in the case any match the queried value, the overall filter should match. This is a logical OR operation, and can be added to using the | operator. If both or__ and and__ are defined within the same filter object, and__ is evaluated first, meaning whether or not all conditions in and__ are matched, if any condition in or__ is matched, the overall filter will match.
and ParticleFilter or list of ParticleFilter One or more subfilters, where in the case all of them they match the queried value, the overall filter should match. This is a logical AND operation, and can be added to using the & operator. If both or__ and and__ are defined within the same filter object, and__ is evaluated first, meaning whether or not all conditions in and__ are matched, if any condition in or__ is matched, the overall filter will match.
id string or list of string Filter by id being equal to one or more given UUIDs.
address any Filter by address matching one or more address selectors.
root any The address which relative address selectors in address are relative to, None means all components.
timestamp string or list of string Filter by timestamp being exactly equal to one or more given datetimes.
after string Filter by timestamp being greater than or equal to a given datetime.
before string Filter by timestamp being less than a given datetime.
timespan string Filter by maximum age relative to after, or minimum age relative to before if after is None. If both after and before are None, filter by maximum age relative to the current time.
min-age string Filter by the age of timestamp, relative to the current time, being greater than or equal to a given threshold.
max-age string Filter by the age of timestamp, relative to the current time, being less than a given threshold.
after-hour integer Filter by the hour value of timestamp being greater than or equal to a given value.
before-hour integer Filter by the hour value of timestamp being less than a given value.
after-minute integer Filter by the minute value of timestamp being greater than or equal to a given value.
before-minute integer Filter by the minute of timestamp being less than a given value.
subsample-every string Subsample results, selecting at most one record per this interval of time. For example, setting timespan to 1 hour and subsample_every to 1 minute will select one record per minute for the last hour, with the total number of time buckets, meaning possible samples, being equal 60.
subsample integer Subsample results, selecting at most one record per subsample divisions of the total time range specified by this filter. To use subsample, a clear start and end to the filtered time range must be specified using some combination of time range filter fields, including: after, before, timespan, min_age, and/or max_age. For example, setting timespan to 1 hour and subsample to 60 will select one record per minute for the last hour, with the total number of time buckets, meaning possible samples, being equal to 60.
subsample-select first or last Specify which record to choose per subsampled time bucket specified by subsample_every and subsample. If unspecified or None, this will default to SubsampleSelect.FIRST.
class string Filter by particles being instances of a specific data class.
connection string or list of string Filter by connection being equal to one or more given connections.
connection-contains string or list of string Filter by connection containing one or more given substrings.
connection-prefix string or list of string Filter by connection starting with one or more given prefixes.
connection-suffix string or list of string Filter by connection ending with one or more given suffixes.
type string or list of string Filter by type being equal to one or more given types.
type-contains string or list of string Filter by type containing one or more given substrings.
type-prefix string or list of string Filter by type starting with one or more given prefixes.
type-suffix string or list of string Filter by type ending with one or more given suffixes.
data-contains string or list of string Filter by whether or not the JSON text of data contains one or more given substrings.
data-prefix string or list of string Filter by whether or not the JSON text of data starts with one or more given prefixes.
data-suffix string or list of string Filter by whether or not the JSON text of data ends with one or more given suffixes.

AlertFilter

Filter for selecting Alert records.

Key Type Default Description
order id or id:asc or id:desc or address or address:asc or address:desc or timestamp or timestamp:asc or timestamp:desc or level or level:asc or level:desc or type or type:asc or type:desc or list of id or id:asc or id:desc or address or address:asc or address:desc or timestamp or timestamp:asc or timestamp:desc or level or level:asc or level:desc or type or type:asc or type:desc Specify ordering of results by field. Suffix a field name with ':desc' for descending order, or with ':asc' for ascending order, which is also the default. If and__ subfilters are defined, and order is unspecified in this root order argument, the last order defined in and__ will be used instead.
limit integer Limit the number of returned results. If any and__ subfilters are defined, and any of them specify a limit which is lower than this root limit argument, the lowest defined limit value in and__ will be used instead.
offset integer Skip over a given number of results. If any and__ subfilters are defined, and any of them specify an offset which is higher than this root offset argument, the highest defined offset value in and__ will be used instead.
or AlertFilter or list of AlertFilter One or more subfilters, where in the case any match the queried value, the overall filter should match. This is a logical OR operation, and can be added to using the | operator. If both or__ and and__ are defined within the same filter object, and__ is evaluated first, meaning whether or not all conditions in and__ are matched, if any condition in or__ is matched, the overall filter will match.
and AlertFilter or list of AlertFilter One or more subfilters, where in the case all of them they match the queried value, the overall filter should match. This is a logical AND operation, and can be added to using the & operator. If both or__ and and__ are defined within the same filter object, and__ is evaluated first, meaning whether or not all conditions in and__ are matched, if any condition in or__ is matched, the overall filter will match.
id string or list of string Filter by id being equal to one or more given UUIDs.
address any Filter by address matching one or more address selectors.
root any The address which relative address selectors in address are relative to, None means all components.
timestamp string or list of string Filter by timestamp being exactly equal to one or more given datetimes.
after string Filter by timestamp being greater than or equal to a given datetime.
before string Filter by timestamp being less than a given datetime.
timespan string Filter by maximum age relative to after, or minimum age relative to before if after is None. If both after and before are None, filter by maximum age relative to the current time.
min-age string Filter by the age of timestamp, relative to the current time, being greater than or equal to a given threshold.
max-age string Filter by the age of timestamp, relative to the current time, being less than a given threshold.
after-hour integer Filter by the hour value of timestamp being greater than or equal to a given value.
before-hour integer Filter by the hour value of timestamp being less than a given value.
after-minute integer Filter by the minute value of timestamp being greater than or equal to a given value.
before-minute integer Filter by the minute of timestamp being less than a given value.
subsample-every string Subsample results, selecting at most one record per this interval of time. For example, setting timespan to 1 hour and subsample_every to 1 minute will select one record per minute for the last hour, with the total number of time buckets, meaning possible samples, being equal 60.
subsample integer Subsample results, selecting at most one record per subsample divisions of the total time range specified by this filter. To use subsample, a clear start and end to the filtered time range must be specified using some combination of time range filter fields, including: after, before, timespan, min_age, and/or max_age. For example, setting timespan to 1 hour and subsample to 60 will select one record per minute for the last hour, with the total number of time buckets, meaning possible samples, being equal to 60.
subsample-select first or last Specify which record to choose per subsampled time bucket specified by subsample_every and subsample. If unspecified or None, this will default to SubsampleSelect.FIRST.
level debug or info or warning or error or critical or list of debug or info or warning or error or critical Filter by level being equal to one or more given levels.
min-level debug or info or warning or error or critical Filter by level being greater than or equal to the given level value.
max-level debug or info or warning or error or critical Filter by level being less than or equal to the given level value.
type string or list of string Filter by type being equal to one or more given types.
type-contains string or list of string Filter by type containing one or more given substrings.
type-prefix string or list of string Filter by type starting with one or more given prefixes.
type-suffix string or list of string Filter by type ending with one or more given suffixes.
data-contains string or list of string Filter by whether or not the JSON text of data contains one or more given substrings.
data-prefix string or list of string Filter by whether or not the JSON text of data starts with one or more given prefixes.
data-suffix string or list of string Filter by whether or not the JSON text of data ends with one or more given suffixes.

LogEntryFilter

Filter for selecting LogEntry records.

Key Type Default Description
order id or id:asc or id:desc or address or address:asc or address:desc or timestamp or timestamp:asc or timestamp:desc or level or level:asc or level:desc or content or content:asc or content:desc or list of id or id:asc or id:desc or address or address:asc or address:desc or timestamp or timestamp:asc or timestamp:desc or level or level:asc or level:desc or content or content:asc or content:desc Specify ordering of results by field. Suffix a field name with ':desc' for descending order, or with ':asc' for ascending order, which is also the default. If and__ subfilters are defined, and order is unspecified in this root order argument, the last order defined in and__ will be used instead.
limit integer Limit the number of returned results. If any and__ subfilters are defined, and any of them specify a limit which is lower than this root limit argument, the lowest defined limit value in and__ will be used instead.
offset integer Skip over a given number of results. If any and__ subfilters are defined, and any of them specify an offset which is higher than this root offset argument, the highest defined offset value in and__ will be used instead.
or LogEntryFilter or list of LogEntryFilter One or more subfilters, where in the case any match the queried value, the overall filter should match. This is a logical OR operation, and can be added to using the | operator. If both or__ and and__ are defined within the same filter object, and__ is evaluated first, meaning whether or not all conditions in and__ are matched, if any condition in or__ is matched, the overall filter will match.
and LogEntryFilter or list of LogEntryFilter One or more subfilters, where in the case all of them they match the queried value, the overall filter should match. This is a logical AND operation, and can be added to using the & operator. If both or__ and and__ are defined within the same filter object, and__ is evaluated first, meaning whether or not all conditions in and__ are matched, if any condition in or__ is matched, the overall filter will match.
id string or list of string Filter by id being equal to one or more given UUIDs.
address any Filter by address matching one or more address selectors.
root any The address which relative address selectors in address are relative to, None means all components.
timestamp string or list of string Filter by timestamp being exactly equal to one or more given datetimes.
after string Filter by timestamp being greater than or equal to a given datetime.
before string Filter by timestamp being less than a given datetime.
timespan string Filter by maximum age relative to after, or minimum age relative to before if after is None. If both after and before are None, filter by maximum age relative to the current time.
min-age string Filter by the age of timestamp, relative to the current time, being greater than or equal to a given threshold.
max-age string Filter by the age of timestamp, relative to the current time, being less than a given threshold.
after-hour integer Filter by the hour value of timestamp being greater than or equal to a given value.
before-hour integer Filter by the hour value of timestamp being less than a given value.
after-minute integer Filter by the minute value of timestamp being greater than or equal to a given value.
before-minute integer Filter by the minute of timestamp being less than a given value.
subsample-every string Subsample results, selecting at most one record per this interval of time. For example, setting timespan to 1 hour and subsample_every to 1 minute will select one record per minute for the last hour, with the total number of time buckets, meaning possible samples, being equal 60.
subsample integer Subsample results, selecting at most one record per subsample divisions of the total time range specified by this filter. To use subsample, a clear start and end to the filtered time range must be specified using some combination of time range filter fields, including: after, before, timespan, min_age, and/or max_age. For example, setting timespan to 1 hour and subsample to 60 will select one record per minute for the last hour, with the total number of time buckets, meaning possible samples, being equal to 60.
subsample-select first or last Specify which record to choose per subsampled time bucket specified by subsample_every and subsample. If unspecified or None, this will default to SubsampleSelect.FIRST.
level debug or info or warning or error or critical or list of debug or info or warning or error or critical Filter by level being equal to one or more given levels.
min-level debug or info or warning or error or critical Filter by level being greater than or equal to the given level value.
max-level debug or info or warning or error or critical Filter by level being less than or equal to the given level value.
content string or list of string Filter by content being equal to one or more given strings.
contains string or list of string Filter by content containing one or more given substrings.
prefix string or list of string Filter by content starting with one or more given prefixes.
suffix string or list of string Filter by content ending with one or more given suffixes.