Monitor an app
When an app slows down or starts to fail, the Observe tab is where you find out what changed and when. It puts the app’s metrics, logs, requests, errors, and cluster events in one place, and it marks deploys and other changes on the same timeline, so you can connect a symptom to its cause.
| View | What it shows | Requirements |
|---|---|---|
| Metrics | Traffic, resources, pods, log volume, and deploys over time. | The metrics store. Traffic panels also need a domain on the app. |
| Logs | Live logs and past logs. | Past logs need the log store. |
| Requests | Individual HTTP requests. | A domain on the app, the log store, and access logs. |
| Errors | Repeated error log lines, grouped into one entry. | Errors from replaced pods need the log store. |
| Events | Crashes and Kubernetes warnings. | None. |
The Requests view does not appear until the requirements are met.
Read metrics
Section titled “Read metrics”- Open the app.
- Go to Observe > Metrics.
- Select a time range. The options go from Last 5 minutes to Last 7 days. To enter exact times, select Custom range.
- (Optional) Select By pod to split the charts by pod.
The view has these sections:
| Section | Panels |
|---|---|
| Traffic and errors | Requests, Error rate, Response time |
| Resources | CPU, CPU throttling, Memory, Network, Disk |
| Pods | Restarts and out-of-memory kills, Waiting containers by reason, Pods not ready, Kubernetes warnings |
| Logs | Error and warning lines, Latest errors |
| Deploys | Deploys, Build time, Queue wait, Where build time goes |
To share the current time range and view, select the copy icon next to the time range.
Review findings
Section titled “Review findings”A finding is a warning at the top of the Metrics view. Orchard creates a finding when one of these signals changes:
- Error rate
- Response time
- Memory use, including a forecast of when the app reaches its memory limit
- CPU throttling
- Restarts
If a change happened in the 10 minutes before the signal changed, the finding names that change. Changes include a deploy, a change to resources or variables, and a node event.
Each finding has these actions:
- View deploy: Opens the related deploy, if there is one.
- Show: Zooms the charts to 15 minutes on each side of the finding.
- Copy link: Copies a link to the finding.
Search logs
Section titled “Search logs”- Open the app.
- Go to Observe > Logs.
- In Filter logs, enter text to search for.
- (Optional) Open the filters to select a level, a time range, or a pod.
To download logs, select the download icon. You can download the lines on screen, export every matching line, or export as NDJSON.
To follow live logs or read why a container crashed, refer to Read logs and open a shell.
Inspect requests
Section titled “Inspect requests”- Open the app.
- Go to Observe > Requests.
- Filter by path, status class, method, or minimum duration.
- Select a request to read its details and the app logs from 30 seconds on each side.
To show only the requests from one client, select the client address in the Client column.
Orchard does not store query strings. It replaces IDs in paths with :id.
Triage errors
Section titled “Triage errors”- Open the app.
- Go to Observe > Errors.
- Select Open, Resolved, Ignored, or All.
- Select a time window.
- Select an error to read its stack trace and the deploys it affected.
Each error has these actions:
- Resolve or Reopen: Changes the status of the error.
- Ignore: Hides the error from the Open list.
- Assign to: Assigns the error to a person.
Read deploy results
Section titled “Read deploy results”After a release settles, Orchard compares the 15 minutes before the release with the 15 minutes after it. Orchard compares response time, error rate, restarts, and memory.
Response time and error rate need at least 200 requests in each window. The result appears on the release in the Activity tab.
A result counts as worse when any of these conditions is true:
| Signal | Condition |
|---|---|
| Response time | The 95th percentile rises by at least 25% and by at least 50 ms. |
| Error rate | The rate at least doubles and rises by at least 0.5 percentage points. |
| Restarts | Restarts rise and reach at least 2. |
A memory change of at least 30% and 64 MiB appears on the result, but it does not count as worse.
To receive a notification when a result is worse, subscribe a channel to the Got worse event (deploy.regressed).
Use the CLI
Section titled “Use the CLI”| Command | Description |
|---|---|
orchard observe overview <deploymentId> | Print a summary for the app. |
orchard observe logs <deploymentId> | Read past logs. |
orchard observe http <deploymentId> | Read HTTP metrics. |
orchard observe errors <deploymentId> | Read grouped errors. |
orchard observe activity <deploymentId> | Read the activity feed. |
orchard observe capabilities <deploymentId> | List the signals available for the app. |
orchard top <id> | Show live pods, resources, and traffic. |
Related resources
Section titled “Related resources”- Create alert rules - Get notified when a metric crosses a threshold for a set period.
- Configure logs and request data - Turn on the log store and access logs that the Logs, Requests, and Errors views read.
orchard observereference - Everyorchard observecommand and flag.