README
¶
Retina
Overview
Retina is a cloud and vendor agnostic container workload observability platform which helps customers with enterprise grade DevOps, SecOps and compliance use cases. It is designed to cater to cluster network administrators, cluster security administrators and DevOps engineers by providing a centralized platform for monitoring application and network health, and security. Retina is capable of collecting telemetry data from multiple sources and aggregating it into a single time-series database. Retina is also capable of sending data to multiple destinations, such as Prometheus, Azure Monitor, and other vendors, and visualizing the data in a variety of ways, like Grafana, Azure Monitor, Azure log analytics, and more.
Documentation
See retina.sh for more information and examples.
Capabilities
Retina is currently supported in AKS. It has two major features:
Metrics
Quick Install Guide
Prerequisites: Go, Helm
-
Clone the repo, then install Retina on your Kubernetes cluster
make helm-install -
Follow steps in Using Managed Prometheus and Grafana to set up metrics collection and visualization.
Captures
Contributing
Office Hours and Community Meetings
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
License
See LICENSE.
Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Contact
"Retina Devs" retina@microsoft.com
Directories
¶
| Path | Synopsis |
|---|---|
|
crd
|
|
|
api/v1alpha1
Package v1alpha1 contains API Schema definitions for the retina v1alpha1 API group +kubebuilder:object:generate=true +groupName=retina.sh
|
Package v1alpha1 contains API Schema definitions for the retina v1alpha1 API group +kubebuilder:object:generate=true +groupName=retina.sh |
|
hack
|
|
|
tools
Module
|
|
|
init
|
|
|
pkg
|
|
|
capture
Package capture contains functions related to handling Retina/Capture.
|
Package capture contains functions related to handling Retina/Capture. |
|
capture/provider
Package provider is a generated GoMock package.
|
Package provider is a generated GoMock package. |
|
common/apiretry
package apiretry provides the retry logic for API calls.
|
package apiretry provides the retry logic for API calls. |
|
controllers/operator/capture
package capture features the retina capture controller.
|
package capture features the retina capture controller. |
|
enricher
Package enricher is a generated GoMock package.
|
Package enricher is a generated GoMock package. |
|
managers/filtermanager
Package filtermanager is a generated GoMock package.
|
Package filtermanager is a generated GoMock package. |
|
managers/watchermanager/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
module/traces
Package traces is a generated GoMock package.
|
Package traces is a generated GoMock package. |
|
plugin/api
Package api provides the api for all Retina eBPF plugins.
|
Package api provides the api for all Retina eBPF plugins. |
|
plugin/api/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
plugin/common
package common contains common functions and types used by all Retina plugins.
|
package common contains common functions and types used by all Retina plugins. |
|
plugin/common/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
plugin/dns
Package dns contains the Retina DNS plugin.
|
Package dns contains the Retina DNS plugin. |
|
plugin/dropreason
Package dropreason contains the Retina DropReason plugin.
|
Package dropreason contains the Retina DropReason plugin. |
|
plugin/dropreason/mocks
Package dropreason is a generated GoMock package.
|
Package dropreason is a generated GoMock package. |
|
plugin/filter
Package filter contains the Retina filter plugin.
|
Package filter contains the Retina filter plugin. |
|
plugin/filter/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
plugin/packetforward
package packetforward contains the Retina packetforward plugin.
|
package packetforward contains the Retina packetforward plugin. |
|
plugin/packetforward/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
plugin/packetparser
package packetparser contains the Retina packetparser plugin.
|
package packetparser contains the Retina packetparser plugin. |
|
plugin/packetparser/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
plugin/registry
Package registry contains the plugin registry for Retina.
|
Package registry contains the plugin registry for Retina. |
|
plugin/tcpretrans
Package tcpretrans contains the Retina tcpretrans plugin.
|
Package tcpretrans contains the Retina tcpretrans plugin. |
|
plugin/windows/hnsstats
Package hnsstats contains the hnsstats plugin.
|
Package hnsstats contains the hnsstats plugin. |
|
pubsub
Package pubsub is a generated GoMock package.
|
Package pubsub is a generated GoMock package. |
|
watchers/apiserver/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
test
|
|
|
utsummary
Summarizes the output of go test.
|
Summarizes the output of go test. |