diff --git a/docs/Admin-and-data/Account/Cloud/invitations.md b/docs/Admin-and-data/Account/Cloud/invitations.md new file mode 100644 index 0000000..f0f34ce --- /dev/null +++ b/docs/Admin-and-data/Account/Cloud/invitations.md @@ -0,0 +1,12 @@ +# Invitations + +View pending invitations and invite new members to your organisation. Navigate to **Organization > Invitations** to open it. + +## Inviting a member + +Click **+ Invite** to send an invitation. The invited user will receive an email with a link to join your organisation. + +Pending invitations are listed here until accepted or cancelled. Once accepted, the user appears in [Members](users.md). + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/Account/Cloud/notifications.md b/docs/Admin-and-data/Account/Cloud/notifications.md new file mode 100644 index 0000000..dec9d4c --- /dev/null +++ b/docs/Admin-and-data/Account/Cloud/notifications.md @@ -0,0 +1,24 @@ +# Notifications + +Choose which notifications you receive. Navigate to **Profile settings > Notifications** to open it. + +![Notification settings](../../../../images/notification-settings.png) + +Each notification type can be toggled on or off: + +| Notification | Default | +|---|---| +| Notify me when assigned a task | On | +| Notify me when @mentioned | On | +| Notify me when a watched service has an incident | On | +| Notify me about incident status & severity changes | On | +| Notify me when someone reacts to my posts | Off | +| Notify me about escalations and SLA breaches | On | + +!!! info + Escalation and SLA breach alerts cannot be silenced. + +Click **Save** to apply changes or **Discard** to cancel. + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/Account/Cloud/watched-services.md b/docs/Admin-and-data/Account/Cloud/watched-services.md new file mode 100644 index 0000000..19a3d5f --- /dev/null +++ b/docs/Admin-and-data/Account/Cloud/watched-services.md @@ -0,0 +1,21 @@ +# Watched Services + +Services you watch to drive watched-service notifications. Navigate to **Profile settings > Watched services** to open it. + +![Watched services](../../../../images/watched-services.png) + +Select the services you want to watch. When a watched service has an incident, you will receive a notification if that notification type is enabled in [Notifications](notifications.md). + +Services are grouped into two sections: + +| Section | Description | +|---|---| +| **Owned by you** | Services where you are listed as an owner | +| **Other services** | All other services in your organisation | + +Use **Select all** or **Deselect all** on each group to bulk-select, or **Clear all** to deselect everything. A counter shows how many are currently selected out of the total available. + +Click **Save** to apply changes or **Discard** to cancel. + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/Billing/manage-subscription.md b/docs/Admin-and-data/Billing/manage-subscription.md new file mode 100644 index 0000000..9e13cad --- /dev/null +++ b/docs/Admin-and-data/Billing/manage-subscription.md @@ -0,0 +1,8 @@ +# Manage Subscription + +Change your subscription plan, preview currency, and cancel. Navigate to **Billing > Manage Subscription** to open it. + +To change or upgrade your subscription, use the **chat with us** button or **email support** directly from this page. + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/shipping.md b/docs/Admin-and-data/shipping.md new file mode 100644 index 0000000..b3edcdc --- /dev/null +++ b/docs/Admin-and-data/shipping.md @@ -0,0 +1,52 @@ +# Shipping + +Configure where the FusionReactor agent sends its telemetry data. Navigate to **Data and Licenses > Shipping** to open it. + +By default the agent ships to OpsPilot, but you can configure it to send to any OTel-compatible provider - such as Datadog, Grafana Cloud, or your own OTel collector. + +!!! note + Shipping is only available if Metric Shipping is included on your plan. + +## Simple + +![Simple shipping](../images/Admin/shipping-simple.png) + +Configure a single destination for all signal types: + +| Field | Description | +|---|---| +| **Endpoint URL** | The destination URL for your OTel collector (e.g. `https://otel-collector.example.com`) | +| **Protocol** | The transport protocol - **gRPC** or **HTTP** | +| **Headers** (optional) | Any authentication headers required by your collector (e.g. `Authorization=Bearer xxx`) | + +## Advanced + +![Advanced shipping](../images/Admin/adv-shipping.png) + +Configure a separate destination for each signal type - **Logs**, **Metrics**, and **Traces** can each be sent to a different endpoint. This is useful if you want to route different data types to different providers. + +Set the **Destination** for each signal type: + +| Option | Description | +|---|---| +| **OpsPilot** | Send the signal to OpsPilot (default) | +| **Custom** | Send to a third-party OTel-compatible endpoint | +| **Disabled** | Stop shipping that signal type entirely | + +When **Custom** is selected, the following fields are available: + +| Field | Description | +|---|---| +| **Endpoint** | The destination URL (e.g. `https://otel-collector.example.com`) | +| **Protocol** | The transport protocol - **gRPC** or **HTTP** | +| **Format** | The data format - **OTLP** | +| **Compression** | Optional compression - **None** or **gzip** | +| **Headers** | Any authentication headers (e.g. `x-api-key=abc123`) | + +Click **Save** to apply your changes. + +!!! info "OTel shipping endpoints" + For a full list of provider-specific endpoints (Datadog, Grafana Cloud, etc.), see the [FusionReactor OTel shipping configuration](https://docs.fusionreactor.io/Monitor-your-data/FR-Agent/Configuration/OTel-shipping-config/). + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/signals.md b/docs/Admin-and-data/signals.md new file mode 100644 index 0000000..43e1e9d --- /dev/null +++ b/docs/Admin-and-data/signals.md @@ -0,0 +1,25 @@ +# Signals + +Control which OpenTelemetry signal types are ingested into your OpsPilot account. Navigate to **Data and Licenses > Signals** to open it. + +![Signals](../images/Admin/preferences.png) + +Disabling a signal type will block all incoming data of that type from being collected or stored. This applies to all incoming data regardless of source (FusionReactor agent, Grafana Alloy, OTel collector, etc.). + +| Signal | Description | +|---|---| +| **Logs** | Enable or disable log ingestion | +| **Metrics** | Enable or disable metric ingestion | +| **Traces** | Enable or disable trace ingestion | +| **AI** | Enable or disable OpsPilot AI | + +All signals are enabled by default. Disabling a signal is useful in emergency situations - for example, if a misconfigured service is causing a log flood or unexpected billing spike, you can immediately disable the relevant signal type to stop ingestion while you investigate. + +!!! warning + Changes may take up to 15 minutes to take effect. + +!!! note + Signals are only available on OpsPilot cloud plans. On-premise plans do not have this feature. + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Data-insights/Features/Incidents/Settings.md b/docs/Data-insights/Features/Incidents/Settings.md index 567f338..677c1a0 100644 --- a/docs/Data-insights/Features/Incidents/Settings.md +++ b/docs/Data-insights/Features/Incidents/Settings.md @@ -1,64 +1,48 @@ -# Incident Settings +# Settings -![!Screenshot](/Data-insights/Features/Incidents/images/setting-main.png) +Configure incident roles, statuses, and severities. Navigate to **Incidents > Settings** to open it. +![Incident settings](../../../images/settings.png) -The **Settings** page allows users to configure key elements of the **Incidents** module, including **Labels**, **Severities**, **Statuses**, and **Roles**. +## Statuses -## Access Settings +Lifecycle states for incidents. These drive MTTA/MTTM analytics and defaults are seeded on first use. -![!Screenshot](/Data-insights/Features/Incidents/images/settings-cog.png) +Each status can be flagged with one or more behaviours: +| Flag | Effect | +|---|---| +| **terminal** | Closes the incident when this status is set | +| **acknowledged** | Stamps the acknowledged time on first entry - used for MTTA calculation | +| **mitigated** | Stamps the mitigated time - used for MTTM calculation | -1. Click the **cog icon** in the top-right of the screen. -2. Navigate to the relevant section: **Labels**, **Severities**, **Statuses**, and **Roles**. +Default statuses: +| Status | Flag | Slug | +|---|---|---| +| Triage | - | `triage` | +| Investigating | acknowledged | `investigating` | +| Mitigated | mitigated | `mitigated` | +| Resolved | terminal | `resolved` | +To add a status, enter a label, slug, and colour then click **+**. Existing statuses can be edited or deleted. +## Roles -### Labels +People-roles that can be assigned on each incident. **Investigator** and **Commander** are built-in and cannot be removed. Add your own (e.g. comms-lead, scribe) by entering a label and slug then clicking **+**. -Labels help categorize incidents for better tracking and filtering. +## Severities -- To add a label, click **+ Add Label** and enter a name, color and description and click **Save**. +Severity levels used when declaring incidents. Existing incidents keep their severity slug even after the severity is removed, so you can delete freely. -- Labels can be edited or deleted at any time. +Default severities: **SEV-1**, **SEV-2**, **SEV-3**, **SEV-4**. -- By default, there will be a label called customers-affected. This label can be edited or deleted. +Options per severity: -- No minimum label requirements exist. +- **SLA budget** - opt-in per severity. Toggle on when editing a row to set ack / mitigate / post-mortem-publish time budgets. +- **Post-mortem gate** - blocks an incident from moving to a terminal status until its post-mortem is published. On by default, customisable per severity. -### Severities +To add a severity, enter a label, short name, slug, and colour then click **+**. -Severities define the impact level of an incident. The available severities are: - -- **Pending** – Severity not yet determined. -- **Low** – Limited impact on business operations. -- **Medium** – Some impact on business operations. -- **High** – Significant impact on business operations. -- **Critical** – Severe business impact requiring immediate attention. - - -### Statuses - -Statuses indicate the current state of an incident. - -- 🟠 **Active** – The incident is currently ongoing. -- 🟢 **Resolved** – The incident has been resolved. - - -### Roles - -Roles define responsibilities within an incident response. - -- **Default Roles:** - - **Commander** – Manages the incident response. - - **Investigator** – Handles the technical investigation. - -- To add a role, click **+ Add Role**, enter a name and description. - -!!! info - Checking the **"Important"** box ensures the role appears on all incidents by default. - - -- **Editing/Deleting:** Roles can be updated or removed, but at least **two roles** must always exist. +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/images/notification-settings.png b/docs/images/notification-settings.png new file mode 100644 index 0000000..3b22b9f Binary files /dev/null and b/docs/images/notification-settings.png differ diff --git a/docs/images/settings.png b/docs/images/settings.png new file mode 100644 index 0000000..3b33b42 Binary files /dev/null and b/docs/images/settings.png differ diff --git a/docs/images/watched-services.png b/docs/images/watched-services.png new file mode 100644 index 0000000..486e952 Binary files /dev/null and b/docs/images/watched-services.png differ diff --git a/mkdocs.yml b/mkdocs.yml index de6611a..4514526 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -88,6 +88,7 @@ nav: - Service Detail: Data-insights/Features/Services/service-detail.md - Traces: Data-insights/Features/Services/traces.md - Logs: Data-insights/Features/Services/logs.md + - Catalog: Admin-and-data/Catalog/catalog.md - FAQ: Data-insights/Features/Services/faq.md - Kubernetes: - Overview: Monitor-your-data/Kubernetes-monitoring/overview.md @@ -116,9 +117,10 @@ nav: - Runbooks: Data-insights/Features/Incidents/runbooks.md - Post-mortem templates: Data-insights/Features/Incidents/postmortem-templates.md - Analytics: Data-insights/Features/Incidents/analytics.md + - Tasks: Data-insights/Features/Tasks/tasks.md + - Notifications: Data-insights/Features/Notifications/notifications.md + - Settings: Data-insights/Features/Incidents/Settings.md - FAQ: Data-insights/Features/Incidents/faq.md - - Tasks: Data-insights/Features/Tasks/tasks.md - - Notifications: Data-insights/Features/Notifications/notifications.md - TELEMETRY: - Logs: Data-insights/Features/explore-logs.md - Metrics: Data-insights/Features/explore-metrics.md @@ -198,26 +200,24 @@ nav: - Getting-started/Tutorials/Common-issues/CF2025-and-FR-2025-Startup-issue.md - Getting-started/Tutorials/Common-issues/FR-wmic.exe-error.md - Getting-started/Tutorials/Common-issues/TLS-deprecation-guide.md - - Administration: - - Usage & Details: Admin-and-data/usage-and-details.md - - Billing: - - Overview: Admin-and-data/Billing/Cloud/overview.md - - FAQ: Admin-and-data/Billing/Cloud/faq.md - - Invoices: Admin-and-data/invoices.md + - Data and Licenses: + - Licence Keys: Admin-and-data/Licensing/Licensing.md - API Keys: Admin-and-data/api-keys.md - - Preferences: Admin-and-data/preferences.md - - Catalog: Admin-and-data/Catalog/catalog.md - - Organization Settings: Admin-and-data/organization-settings.md - - Users: - - Organization Users: Admin-and-data/Account/Cloud/users.md - - User Profile: Admin-and-data/Account/Cloud/profile.md - - User Security: Admin-and-data/Account/Cloud/security.md - - Data limits: Admin-and-data/Limits.md - - Security: Admin-and-data/security.md - - Legal: - - Terms of Service: Admin-and-data/tos.md - - EULA: Admin-and-data/EULA.md - - Third Party Licenses: Admin-and-data/Third-Party-Licenses/licenses.md + - Shipping: Admin-and-data/shipping.md + - Signals: Admin-and-data/signals.md + - Billing: + - Overview: Admin-and-data/Billing/Cloud/overview.md + - Invoices: Admin-and-data/invoices.md + - Manage Subscription: Admin-and-data/Billing/manage-subscription.md + - Usage: Admin-and-data/usage-and-details.md + - Organization: + - General: Admin-and-data/organization-settings.md + - Members: Admin-and-data/Account/Cloud/users.md + - Invitations: Admin-and-data/Account/Cloud/invitations.md + - Profile settings: + - Profile: Admin-and-data/Account/Cloud/profile.md + - Notifications: Admin-and-data/Account/Cloud/notifications.md + - Watched services: Admin-and-data/Account/Cloud/watched-services.md - Contribute: - Contribute/how-to-contribute.md - Style Guide: