artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 17:11:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

monitoring: remove very long description (#59338)

Browse Source
This commit is contained in:
Robert Lin 2024-01-04 22:56:28 -08:00 committed by GitHub
parent 2345ed8fc3
commit 8bce54ee62
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/admin/observability/alerts.md
View File

@ -231,18 +231,19 @@ Generated query for warning alert: `max((histogram_quantile(0.9, sum by (le) (ra
## frontend: blob_load_latency
<p class="subtitle">90th percentile blob load latency over 10m. The 90th percentile of API calls to the blob route in the frontend API is at 5 seconds or more, meaning calls to the blob route, are slow to return a response. The blob API route provides the files and code snippets that the UI displays. When this alert fires, the UI will likely experience delays loading files and code snippets. It is likely that the gitserver and/or frontend services are experiencing issues, leading to slower responses.</p>
<p class="subtitle">90th percentile blob load latency over 10m</p>
**Descriptions**
- <span class="badge badge-critical">critical</span> frontend: 5s+ 90th percentile blob load latency over 10m. The 90th percentile of API calls to the blob route in the frontend API is at 5 seconds or more, meaning calls to the blob route, are slow to return a response. The blob API route provides the files and code snippets that the UI displays. When this alert fires, the UI will likely experience delays loading files and code snippets. It is likely that the gitserver and/or frontend services are experiencing issues, leading to slower responses.
- <span class="badge badge-critical">critical</span> frontend: 5s+ 90th percentile blob load latency over 10m
**Next steps**
- Confirm that the Sourcegraph frontend has enough CPU/memory using the provisioning panels.
- When this alert fires, calls to the blob route are slow to return a response. The UI will likely experience delays loading files and code snippets. It is likely that the gitserver and/or frontend services are experiencing issues, leading to slower responses.
- Confirm that the Sourcegraph gitserver and frontend services have enough CPU/memory using the provisioning panels.
- Trace a request to see what the slowest part is: https://docs.sourcegraph.com/admin/observability/tracing
- Check that gitserver containers have enough CPU/memory and are not getting throttled.
- Learn more about the related dashboard panel in the [dashboards reference](./dashboards.md#frontend-blob-load-latency).
- More help interpreting this metric is available in the [dashboards reference](./dashboards.md#frontend-blob-load-latency).
- **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert:
```json

4
doc/admin/observability/dashboards.md generated
View File

@ -149,7 +149,9 @@ Query: `histogram_quantile(0.9, sum by(le) (rate(src_http_request_duration_secon
#### frontend: blob_load_latency
<p class="subtitle">90th percentile blob load latency over 10m. The 90th percentile of API calls to the blob route in the frontend API is at 5 seconds or more, meaning calls to the blob route, are slow to return a response. The blob API route provides the files and code snippets that the UI displays. When this alert fires, the UI will likely experience delays loading files and code snippets. It is likely that the gitserver and/or frontend services are experiencing issues, leading to slower responses.</p>
<p class="subtitle">90th percentile blob load latency over 10m</p>
- The blob API route provides the files and code snippets that the UI displays.
Refer to the [alerts reference](./alerts.md#frontend-blob-load-latency) for 1 alert related to this panel.

8
monitoring/definitions/frontend.go
View File

@ -162,13 +162,17 @@ func Frontend() *monitoring.Dashboard {
},
{
Name: "blob_load_latency",
Description: "90th percentile blob load latency over 10m. The 90th percentile of API calls to the blob route in the frontend API is at 5 seconds or more, meaning calls to the blob route, are slow to return a response. The blob API route provides the files and code snippets that the UI displays. When this alert fires, the UI will likely experience delays loading files and code snippets. It is likely that the gitserver and/or frontend services are experiencing issues, leading to slower responses.",
Description: "90th percentile blob load latency over 10m",
Query: `histogram_quantile(0.9, sum by(le) (rate(src_http_request_duration_seconds_bucket{route="blob"}[10m])))`,
Critical: monitoring.Alert().GreaterOrEqual(5),
Panel: monitoring.Panel().LegendFormat("latency").Unit(monitoring.Seconds),
Owner: monitoring.ObservableOwnerSource,
Interpretation: `
- The blob API route provides the files and code snippets that the UI displays.
`,
NextSteps: `
- Confirm that the Sourcegraph frontend has enough CPU/memory using the provisioning panels.
- When this alert fires, calls to the blob route are slow to return a response. The UI will likely experience delays loading files and code snippets. It is likely that the gitserver and/or frontend services are experiencing issues, leading to slower responses.
- Confirm that the Sourcegraph gitserver and frontend services have enough CPU/memory using the provisioning panels.
- Trace a request to see what the slowest part is: https://docs.sourcegraph.com/admin/observability/tracing
- Check that gitserver containers have enough CPU/memory and are not getting throttled.
`,

6
monitoring/monitoring/monitoring.go
View File

@ -596,6 +596,12 @@ func (o Observable) validate(variables []ContainerVariable) error {
if len(o.Description) == 0 {
return errors.New("Description must be set")
}
// Avoid paragraphs in the brief description
const maxDescriptionLength = 120
if len(o.Description) > maxDescriptionLength {
return errors.Newf("Description must be under %d characters (current length: %d) - to provide more context, use Interpretation and NextSteps fields instead",
maxDescriptionLength, len(o.Description))
}
if first, second := string([]rune(o.Description)[0]), string([]rune(o.Description)[1]); first != strings.ToLower(first) && second == strings.ToLower(second) {
return errors.Errorf("Description must be lowercase except for acronyms; found \"%s\"", o.Description)
}