Skip to content

About

Community-shared Sluicio system types — portable YAML monitoring definitions (detection prefixes + starter health checks) for brokers, gateways, and runtimes. PRs welcome.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

13 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

Sluicio system types

Community-shared system types for Sluicio — portable monitoring definitions for the brokers, gateways, and runtimes that carry your integrations. Each file bundles what Sluicio needs to recognise a system and watch it: metric-name detection prefixes and a set of starter health checks (metric thresholds, log matchers, failed-trace / latency / traffic dead-man rules).

One YAML file. Export from your cell, import into any other. Apache-2.0.

Use a type from this repo

Download the .systemtype.yaml you want from types/, then either:

  • UI: System types → Import… → pick the file, or

  • API:

    curl -X POST https://your-cell.example.com/api/v1/system-types/import \
      -H "Authorization: Bearer $TOKEN" \
      -H "Content-Type: application/yaml" \
      --data-binary @rabbitmq.systemtype.yaml

Importing a key that matches a Sluicio built-in creates your org's override of it; a new key becomes a custom type. Add ?replace=true to update a type you imported before.

Share your own

  1. Build your type in Sluicio (System types → New, or fork a built-in and tune the checks on a real system).
  2. System types → Export — you get <key>.systemtype.yaml.
  3. Open a PR adding it to types/.

Guidelines:

  • Name the file <key>.systemtype.yaml; keys are lowercase ([a-z0-9._-], max 63 chars).
  • Add a short comment header: what it monitors, which versions you tested against, anything a stranger should know before trusting the thresholds.
  • No credentials, internal hostnames, or company-specific values — the file is meant to travel.
  • Thresholds are starting points, not gospel — say so in the header if yours are opinionated.

The full format specification lives in the app repo: docs/system-types-sharing.md.

Included types

Type File What it watches
RabbitMQ types/rabbitmq.systemtype.yaml Queue depth, consumers, delivery health
ActiveMQ Artemis types/artemis.systemtype.yaml Address/queue metrics, broker health
KrakenD types/krakend.systemtype.yaml Gateway 5xx/error traces, backend transport failures & timeouts
Azure Service Bus types/azure-servicebus.systemtype.yaml Per-queue/subscription depth and DLQ metrics
Paperless-ngx types/paperless-ngx.systemtype.yaml Document ingest failures/latency, queue backlog, unfiled documents, component health, storage
OTel Collector types/otel-collector.systemtype.yaml Pipeline throughput, refused/dropped telemetry
.NET service types/dotnet-service.systemtype.yaml Runtime counters, error rates
Apache Kafka types/kafka.systemtype.yaml Consumer-group lag, empty groups, in-sync replicas, broker count
Confluent Kafka types/confluent-kafka.systemtype.yaml Consumer lag, cluster load, hot partitions (Confluent Cloud Metrics API)
NATS types/nats.systemtype.yaml Slow consumers, client connections, server memory
Debezium types/debezium.systemtype.yaml Connector connectivity, CDC lag, event-queue capacity
Kubernetes types/kubernetes.systemtype.yaml Node readiness, deployment availability, restart loops, failed pods and Jobs, node disk (k0s, k3s, RKE2, MicroK8s, kubeadm, EKS, AKS, GKE, OpenShift)
Apache Camel types/camel.systemtype.yaml Per-route failures, dead-lettering, in-flight backlog, stopped routes, broker redeliveries, failed and slow exchanges
Node-RED types/node-red.systemtype.yaml Failed and incomplete flow executions, slow flows, a runtime gone quiet. Detected from node_red. SPAN ATTRIBUTES, not metric names
Apache Airflow types/airflow.systemtype.yaml The SCHEDULER: per-DAG task and operator failures, a stopped scheduler, pool starvation, executor saturation
Airflow DAG processor types/airflow-dag-processor.systemtype.yaml DAG import errors, a stopped processor, an empty DAG bag, stale or slow parsing
Airflow triggerer types/airflow-triggerer.systemtype.yaml A stopped triggerer, a trigger blocking the async loop, capacity
Apache Airflow types/airflow.systemtype.yaml Platform only: scheduler/triggerer/DAG-processor heartbeats, DAG import errors, pool starvation, executor saturation, blocked triggerer. Per-DAG checks belong on integrations - see the file header
WSO2 API Manager types/wso2-apim.systemtype.yaml Failed invocations, gateway latency, dead-man, error logs, JVM heap

Most of these mirror the built-ins shipped with Sluicio, exported verbatim - fork away. Apache Airflow is not a built-in; import it from here.

About

Community-shared Sluicio system types — portable YAML monitoring definitions (detection prefixes + starter health checks) for brokers, gateways, and runtimes. PRs welcome.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors