README
¶
Orb is a new kind of observability platform that helps operators, developers, and end users understand their networks, distributed applications, and traffic flows in real time.
Ready to dive in? See orb.community for installation instructions.
Why Orb?
Distributed Deep Network Observability
Orb manages a fleet of agents deployed across distributed, hybrid infrastructure: containers, VMs, servers, routers and switches. The agent taps into traffic streams and extracts real time insights, resulting in light-weight, actionable metrics.
Streaming Analysis at the Edge
Based on the pktvisor observability agent, Orb's goal is to push analysis to the edge, where high resolution data can be analysed in real time without the need to send raw data to a central location for batch processing. Current analysis focuses on L2-L3 Network, DNS, and DHCP with more analyzers in the works.
Realtime Agent Orchestration
Orb uses IoT principals to allow the observability agents to connect out to the Orb central control plane, avoiding firewall problems. Once connected, agents are controlled in real time from the Orb Portal or REST API, orchestrating observability policies designed to precisely extract the desired insights. Agents are grouped and addressed based on tags.
Flexible Integration With Modern Observability Stacks
Orb was built to integrate with modern observability stacks, supporting Prometheus natively and designed to support arbitrary sinks in the future. Collection and sinking of the metrics from the agents is included; there is no need to run additional data collection pipelines for Orb metrics.
Portal and REST API Included
Orb includes a modern, responsive UI for managing Agents, Agent Groups, Policies and Sinks. Orb is API first, and all platform functionality is available for automation via the well documented REST API.
Open Source, Vendor Neutral, Cloud Native
Orb is free, open source software (FOSS) released under MPL. It's a modern microservices application that can be deployed to any Kubernetes service in private or public cloud. It does not depend on any one vendor to function, thus avoiding vendor lock-in.
Backed by NS1
Orb was born at NS1 Labs, where we're committed to making open source, dynamic edge observability a reality .
- Installation Instructions
- View our Wiki for technical and architectural information
- File an issue
- Follow our public work board
- Start a Discussion
- Join us on Slack
- Send mail to info@pktvisor.dev
Directories
¶
| Path | Synopsis |
|---|---|
|
otel/otlpmqttexporter
Package otlpmqttexporter exports data by using the OTLP format to an MQTT endpoint.
|
Package otlpmqttexporter exports data by using the OTLP format to an MQTT endpoint. |
|
cmd
|
|
|
postgres
Package postgres contains repository implementations using PostgreSQL as the underlying database.
|
Package postgres contains repository implementations using PostgreSQL as the underlying database. |
|
redis/consumer
Package esconsumer contains events esconsumer for events
|
Package esconsumer contains events esconsumer for events |
|
redis/producer
Package producer contains the domain events needed to support event sourcing of Sink service actions.
|
Package producer contains the domain events needed to support event sourcing of Sink service actions. |
|
internal
|
|
|
redis/consumer
Package esconsumer contains events esconsumer for events
|
Package esconsumer contains events esconsumer for events |
|
pkg
|
|
|
api/grpc
Package grpc contains implementation of service gRPC API.
|
Package grpc contains implementation of service gRPC API. |
|
postgres
Package postgres contains repository implementations using PostgreSQL as the underlying database.
|
Package postgres contains repository implementations using PostgreSQL as the underlying database. |
|
redis/consumer
Package esconsumer contains events esconsumer for events
|
Package esconsumer contains events esconsumer for events |
|
redis/producer
Package producer contains the domain events needed to support event sourcing of Sink service actions.
|
Package producer contains the domain events needed to support event sourcing of Sink service actions. |
|
otel/kafkafanoutexporter
Package kafkaexporter exports trace data to Kafka.
|
Package kafkaexporter exports trace data to Kafka. |
|
otel/kafkafanoutexporter/internal/awsmsk
Package msk implements the required IAM auth used by AWS' managed Kafka platform to be used with the Surama kafka producer.
|
Package msk implements the required IAM auth used by AWS' managed Kafka platform to be used with the Surama kafka producer. |
|
otel/orbreceiver/internal/sharedcomponent
Package sharedcomponent exposes util functionality for receivers and exporters that need to share state between different signal types instances such as net.Listener or os.File.
|
Package sharedcomponent exposes util functionality for receivers and exporters that need to share state between different signal types instances such as net.Listener or os.File. |
|
postgres
Package postgres contains repository implementations using PostgreSQL as the underlying database.
|
Package postgres contains repository implementations using PostgreSQL as the underlying database. |
|
redis/consumer
Package esconsumer contains events esconsumer for events
|
Package esconsumer contains events esconsumer for events |
|
redis/producer
Package producer contains the domain events needed to support event sourcing of Sink service actions.
|
Package producer contains the domain events needed to support event sourcing of Sink service actions. |