Skip to main content

Logz.io logs plugin for Imbi

Project description

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

Assign the plugin to a service application in Imbi. The following options and credentials are available.

Options

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

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

Project details


Download files

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

Source Distribution

imbi_plugin_logzio-2.10.0.tar.gz (110.4 kB view details)

Uploaded Source

Built Distribution

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

imbi_plugin_logzio-2.10.0-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file imbi_plugin_logzio-2.10.0.tar.gz.

File metadata

  • Download URL: imbi_plugin_logzio-2.10.0.tar.gz
  • Upload date:
  • Size: 110.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for imbi_plugin_logzio-2.10.0.tar.gz
Algorithm Hash digest
SHA256 22a69006e0c710e29581e692ae68448f1b86fb2d7ceecd149641916269537e5f
MD5 e9b7108a28032628dc2665fab4673cd4
BLAKE2b-256 d18a9ed7f5013f3f459409d84ac4ac26364eddab70b642bf7d6fe5c06c84c07b

See more details on using hashes here.

Provenance

The following attestation bundles were made for imbi_plugin_logzio-2.10.0.tar.gz:

Publisher: publish.yml on AWeber-Imbi/imbi-plugin-logzio

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

File details

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

File metadata

File hashes

Hashes for imbi_plugin_logzio-2.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d594a3a4ac692e70e2a1f748a56404ab2308655fcc551ea41f6e4eb4befd59aa
MD5 51c2c3048215f7af7b19810bb84f6fe7
BLAKE2b-256 ef23e2177771dd38124186023fcc2cb1d6ceda255b6958e8e0f02250ee096ed0

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on AWeber-Imbi/imbi-plugin-logzio

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