You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-reference/filtering.mdx
+22Lines changed: 22 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,28 @@ GET /api/incidents?filter[status]=1
15
15
Each endpoint may support different fields for filtering. Check the documentation for the specific endpoint you are working with.
16
16
</Note>
17
17
18
+
## Including related resources
19
+
20
+
Many endpoints can embed related resources in the response using the `include` parameter. Pass a comma-separated list
21
+
of the relationships you want to include:
22
+
23
+
```http
24
+
GET /api/incidents?include=components,updates
25
+
```
26
+
27
+
<Note>
28
+
Each endpoint supports a different set of includes. Check the documentation for the specific endpoint you are
29
+
working with.
30
+
</Note>
31
+
32
+
## Filtering by metadata
33
+
34
+
Resources that support metadata can be filtered by their metadata keys using the `filter[meta][key]` syntax:
35
+
36
+
```http
37
+
GET /api/incidents?filter[meta][region]=us-east-1
38
+
```
39
+
18
40
## Sorting
19
41
20
42
You can sort the results of an endpoint by passing the `sort` parameter. The `sort` parameter should be a comma-separated list of fields to sort by. You can also specify the sort order by appending `asc` or `desc` to the field name.
Copy file name to clipboardExpand all lines: v3.x/configuration/beacon.mdx
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,14 +9,15 @@ This data helps us understand how you use Cachet and how we can improve it.
9
9
10
10
## Configuration
11
11
12
-
By default, Cachet's beacon is turned off. You can opt in by setting the `CACHET_BEACON` environment variable to `true`.
12
+
Cachet's beacon is **enabled by default**. If you'd prefer not to send any usage data, you can opt out by setting the
13
+
`CACHET_BEACON` environment variable to `false`.
13
14
14
15
```ini .env
15
-
CACHET_BEACON=true
16
+
CACHET_BEACON=false
16
17
```
17
18
18
19
<Tip>
19
-
If you're limiting outbound requests on your server and you'd like to opt into the beacon, you'll need to allow outbound requests to `https://cachethq.io`.
20
+
If you're limiting outbound requests on your server and you'd like to keep the beacon enabled, you'll need to allow outbound requests to `https://cachethq.io`.
20
21
</Tip>
21
22
22
23
### Configuring the scheduler
@@ -40,4 +41,4 @@ The beacon collects the following data:
40
41
-**Cachet Version**: The version of Cachet you're running.
41
42
-**Docker**: Whether you're running Cachet in a Docker container.
42
43
-**Database**: The type of database you're using.
43
-
-**Usage Data**: How you're using Cachet, such as the number of incidents, components, subscribers, etc.
44
+
-**Usage Data**: How you're using Cachet, such as the number of incidents, components, subscribers, etc.
Copy file name to clipboardExpand all lines: v3.x/configuration/cachet.mdx
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,14 @@ information about your organization, services, or status page.
26
26
The "Timezone" setting allows you to set the timezone for your status page. Cachet uses it to display the correct time
27
27
for incidents and scheduled maintenance. The status page will always display timestamps in the user's local time.
28
28
29
+
## Language
30
+
31
+
Cachet can display your status page in a number of languages. The "Language" selector, along with the
32
+
[Timezone](#timezone) settings, can be found on the "Manage Localization" page under the "Settings" navigation group.
33
+
34
+
Cachet currently ships with the following locales: Deutsch (DE), Deutsch (AT), Deutsch (CH), English, English (UK),
35
+
Spanish (ES), 한국어, Nederlands, Filipino, Português (BR), 简体中文, and 繁體中文.
36
+
29
37
## Incident days
30
38
31
39
This setting allows you to specify the number of days to display incidents on your status page. Cachet pushes incidents
@@ -90,12 +98,13 @@ We’d really appreciate it if you could leave this enabled to help spread the w
90
98
91
99
### Display graphs
92
100
93
-
Enable the "Display Graphs" setting to display graphs for metrics, such as uptime and response time, on your status
94
-
page.
101
+
Enable the "Display Graphs" setting to display [metric](/v3.x/guide/metrics) graphs, such as uptime and response time,
102
+
on your status page. This setting is enabled by default.
95
103
96
-
<Warning>
97
-
Metrics are not fully supported in Cachet v3.x. This setting will have no effect until metrics are implemented.
98
-
</Warning>
104
+
### Recent incidents only
105
+
106
+
Enable the "Recent Incidents Only" setting to show only recent incidents on your status page. When enabled, you can
107
+
set the number of days to include, and Cachet hides any incidents older than that window.
99
108
100
109
### Show timezone
101
110
@@ -106,6 +115,11 @@ When enabled, the "Show Timezone" setting displays your status page's timezone i
106
115
Enable the "Only Show Disrupted Days" setting to show only the days with incidents on your status page. By default,
107
116
the status page displays all days.
108
117
118
+
### Dynamic favicon
119
+
120
+
When the "Dynamic Favicon" setting is enabled, your status page's favicon reflects the current system status, so a
121
+
browser tab shows at a glance whether everything is operational or there's an ongoing issue.
122
+
109
123
### Show dashboard link
110
124
111
-
The "Show Dashboard Link" setting controls the "Dashboard" link in the header of your status page. When enabled, the status page displays a link to the Cachet dashboard.
125
+
The "Show Dashboard Link" setting controls the "Dashboard" link in the header of your status page. When enabled, the status page displays a link to the Cachet dashboard.
Copy file name to clipboardExpand all lines: v3.x/guide/components.mdx
+39-2Lines changed: 39 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,13 +31,14 @@ Cachet also provides a simple way of updating your component statuses directly f
31
31
32
32
### Component statuses
33
33
34
-
Components can have one of five statuses:
34
+
Components can have one of six statuses:
35
35
36
36
- <Tooltiptip="Status ID: 1"><Iconicon="square-1"/></Tooltip> **Operational**: The component is working as expected.
37
37
- <Tooltiptip="Status ID: 2"><Iconicon="square-2"/></Tooltip> **Performance Issues**: The component is experiencing performance issues.
38
38
- <Tooltiptip="Status ID: 3"><Iconicon="square-3"/></Tooltip> **Partial Outage**: The component is experiencing partial outage.
39
39
- <Tooltiptip="Status ID: 4"><Iconicon="square-4"/></Tooltip> **Major Outage**: The component is experiencing a major outage.
40
40
- <Tooltiptip="Status ID: 5"><Iconicon="square-5"/></Tooltip> **Unknown**: The component status is unknown.
41
+
- <Tooltiptip="Status ID: 6"><Iconicon="square-6"/></Tooltip> **Under Maintenance**: The component is undergoing maintenance. [Schedules](/v3.x/guide/schedules) can set this status automatically.
41
42
42
43
## Component groups
43
44
@@ -47,6 +48,29 @@ To help organize your components, you can group them together into component gro
47
48
Cachet will automatically group any ungrouped components together. Cachet displays ungrouped components beneath any
48
49
component groups on your status page.
49
50
51
+
A component group has the following properties:
52
+
53
+
-**Name**: The name of the group.
54
+
-**Visibility**: Whether the group is visible to users, guests, or always hidden.
55
+
-**Collapsed**: How the group behaves on the status page (see [Collapse behavior](#collapse-behavior)).
56
+
-**Order by**: How components within the group are ordered (see [Ordering strategies](#ordering-strategies)).
57
+
58
+
### Group visibility
59
+
60
+
Like other resources, each component group has a visibility setting that controls who can see it:
61
+
62
+
-**Authenticated**: Only visible to authenticated dashboard users.
63
+
-**Guest**: Visible to everyone, including guests.
64
+
-**Hidden**: Never displayed on the status page.
65
+
66
+
### Collapse behavior
67
+
68
+
You can control whether a group appears expanded or collapsed on your status page. Each group can be set to one of:
69
+
70
+
-**Expanded**: The group is always expanded, showing all of its components.
71
+
-**Collapsed**: The group is always collapsed.
72
+
-**Collapsed unless a component is in an incident**: The group stays collapsed until one of its components is not operational, at which point Cachet expands it automatically. This keeps large status pages tidy while still drawing attention to problems.
73
+
50
74
## Reordering components
51
75
52
76
You may reorder components via the dashboard by dragging and dropping them into the desired order. To do this,
@@ -59,4 +83,17 @@ You can also reorder components when editing a component group. The order will r
Copy file name to clipboardExpand all lines: v3.x/guide/metrics.mdx
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,7 @@ A metric consists of:
19
19
-**Places**: The number of decimal places to display.
20
20
-**Metric Type**: The type of calculation to perform on the metric, e.g. sum or average.
21
21
-**Threshold**: The threshold determines when a new point should be created or the last point updated.
22
+
-**Show when empty**: Whether Cachet displays the metric on your status page when it has no points. When disabled, the metric is hidden until it has data.
22
23
-**Visible**: Whether the metric is visible to users, guests or always hidden.
23
24
24
25
## Metric points
@@ -28,4 +29,9 @@ A metric is made up of multiple points that you add over time. Each point consis
28
29
-**Value**: The value of the metric at this point in time.
29
30
-**Timestamp**: The time the metric was recorded.
30
31
31
-
For performance, if you create a metric point within the threshold of an existing point, Cachet updates the existing point with the new value.
32
+
For performance, if you create a metric point within the threshold of an existing point, Cachet updates the existing point with the new value.
33
+
34
+
## Reordering metrics
35
+
36
+
You can reorder metrics to control the order they appear in on your status page, in the same way you
0 commit comments