Skip to content
This repository has been archived by the owner on Oct 20, 2023. It is now read-only.

Sidecar or Monitor? I chose Sidecar #1

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ The SMI specification outlines three basic resource types:

* MutualTLS - a resource for managing and configuring encryption between services
* Canary - a resource for defining flexible routing between different versions of a system
* Monitor - a resource that defines a side car for basic HTTP monitoring that can be installed alongside an application.
* Sidecar - a resource that defines a sidecar (e.g. for basic HTTP monitoring) that can be installed alongside an application.

The details of the APIs can be founded in [Specification.md](dpecification.md)
The details of the APIs can be founded in [specification.md](specification.md)
8 changes: 4 additions & 4 deletions specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@ spec:
- service-3: 10%
```

### Monitor
The Monitor resource defines a sidecar which is injected alongside the application to perform HTTP monitoring. The Monitor collects standard HTTP metrics (status codes, requests / second, latency, etc) and exposes a common interface using Prometheus metrics.
### Sidecar
The Sidecar resource defines a sidecar container which is injected alongside the application. The primary use case is to perform HTTP monitoring. A monitoring sidecar collects standard HTTP metrics (status codes, requests / second, latency, etc) and exposes a common interface using Prometheus metrics.
These metrics can be picked up by a metrics scraper and pushed to either an in-cluster or
in-cloud monitoring endpoint.

```yaml
apiVersion: v1beta1
kind: Monitor
kind: Sidecar
name: my-monitor
spec:
# The monitor sidecar is added to Pods matching these labels
Expand All @@ -66,4 +66,4 @@ spec:
team: my-team
app: my-server
region: us-east
```
```