imbi-plugin-logzio

Logz.io provider for the Imbi project logs tab, surfacing relevant logs without requiring search knowledge.

Installation

pip install imbi-plugin-logzio

Configuration

Create a Logz.io Integration in Imbi and enable its Logs capability. Connection settings and the API token live on the Integration; the query-shaping settings are scoped to the Logs capability.

Integration Options

Name Label Default Description
region Region us Logz.io account region. One of us, eu, uk, au, ca.
timeout_seconds Request Timeout 15 Per-request timeout in seconds.

Logs Capability Options

Name Label Default Description
base_query Base Query Template — Elasticsearch query_string applied as a must clause. Supports ${project_slug}, ${org_slug}, ${environment}, ${project_id}.
timestamp_field Timestamp Field @timestamp Source field containing the log timestamp.
message_field Message Field message Source field containing the log message.
level_field Level Field level Source field containing the log severity level.
environment_field Environment Field — Log field used to filter by environment. Leave blank to disable automatic environment filtering.
default_environments Default Environments — Comma-separated environments pre-selected in the UI.

Region → Hostname

Region API Host
us api.logz.io
eu api-eu.logz.io
uk api-uk.logz.io
au api-au.logz.io
ca api-ca.logz.io

Credentials

Name Description
api_token Logz.io API token with search privileges (X-API-TOKEN header).

Base Query Templates

Use ${variable} placeholders to scope log searches to a project automatically:

kubernetes.namespace_name:${project_slug} AND env:${environment}

Variables substituted at search time: project_slug, org_slug, environment, project_id. Unknown variables are rejected at configuration time.

Filter Operators

Operator Translation
eq Elasticsearch term
ne Elasticsearch bool.must_not.term
contains match_phrase on the configured message_field; non-leading wildcard (value*) on other fields
starts_with Elasticsearch prefix
regex Elasticsearch regexp (patterns starting with .*, *, or ? are rejected)

Development

# Clone alongside imbi-common
git clone https://github.com/AWeber-Imbi/imbi-plugin-logzio
git clone https://github.com/AWeber-Imbi/imbi-common

cd imbi-plugin-logzio
UV_CONFIG_FILE=/dev/null uv sync
UV_CONFIG_FILE=/dev/null uv run pytest tests/
UV_CONFIG_FILE=/dev/null uv run coverage run -m pytest tests/ && uv run coverage report

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.23.0)

Owner

PyPI data
Data sourced directly from PyPI's database.

Credits

Author: Gavin M. Roy

License expression

BSD-3-Clause
View SPDX License List

Requires

Python >=3.14

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

imbi_plugin_logzio-2.22.0-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file imbi_plugin_logzio-2.22.0-py3-none-any.whl.

File metadata

File hashes

Hashes for imbi_plugin_logzio-2.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 924369f6a4d9f652a89f19d14df470b642ec05c6c12ebf1664398f75a926af54
MD5 f421044183c1303c0f0a59be34cc512e
BLAKE2b-256 ae2777bbbf40bac5e234353aa41c1a3233db4ac82351202d1459496f2c965fc3

See more details on using hashes here.

Provenance

The following attestation bundles were made for imbi_plugin_logzio-2.22.0-py3-none-any.whl:

Publisher: release.yml on AWeber-Imbi/imbi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page