Skip to content

Commit 9093228

Browse files
New docs: General Settings and Service Graph | update docs: Work Group, Pipeline, License Management (#272)
1 parent 5dcb773 commit 9093228

16 files changed

+424
-143
lines changed

docs/images/action-tab.png

70.5 KB
Loading
134 KB
Loading

docs/images/filter-pipeline.png

88.2 KB
Loading

docs/images/pipeline-list-view.png

69.1 KB
Loading

docs/images/search-pipeline.png

84.2 KB
Loading

docs/images/sort-columns.png

69.4 KB
Loading

docs/images/theme-config.png

93.3 KB
Loading

docs/user-guide/management/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
nav:
2+
- General Settings: general-settings.md
23
- Management Overview: index.md
34
- Streaming Search: streaming-search.md
45
- Streaming Aggregation: aggregation-cache.md
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
## General settings
2+
This page explains how to use the settings available under General Settings in OpenObserve. These settings allow you to configure scrape interval, theme colors, and Enterprise branding.
3+
4+
## What you can do in general settings
5+
General settings provides the following configuration options:
6+
7+
- Scrape interval
8+
- Theme configuration for light and dark modes
9+
- Enterprise branding features such as custom logo text and custom logo
10+
11+
!!! note "Note"
12+
`_meta` organizations can access all settings. Regular organizations see only the options allowed for their specific license and permissions.
13+
14+
### Scrape interval
15+
> This setting is available for all organizations.
16+
17+
![theme-config](../../images/theme-config.png)
18+
The scrape interval defines how often the monitoring system collects metrics. Enter the number of seconds and select Save.
19+
20+
### Theme configuration
21+
Theme configuration allows you to manage the default colors for light mode and dark mode for your organization. When you save these values, they are applied across the UI for all users in the organization.
22+
![theme-config](../../images/theme-config.png)
23+
24+
You can set the following fields:
25+
26+
- Light mode color
27+
- Dark mode color
28+
29+
Select **Save** to apply the changes.
30+
31+
### Theme configuration using environment variables
32+
You can also configure the default theme colors at the system level. These values become the initial defaults for all organizations.
33+
34+
- `ZO_DEFAULT_THEME_LIGHT_MODE_COLOR`: Sets the default color used in light mode. Default:"#3F7994"
35+
- `ZO_DEFAULT_THEME_DARK_MODE_COLOR`: Sets the default color used in dark mode. Default: "#5B9FBE"
36+
37+
If these variables are set, the UI loads these colors automatically unless overridden by an organization through the General Settings page.
38+
39+
### Enterprise branding
40+
Enterprise branding options appear only in the `_meta` org when Enterprise features are enabled.
41+
![enterprise-branding](../../images/enterprise-branding.png)
42+
<br>
43+
44+
**Custom logo text**
45+
Use this field to replace the default OpenObserve text shown in the header. Enter the required text and save the changes.
46+
<br>
47+
48+
**Custom logo**
49+
Upload a custom branding logo to replace the default OpenObserve logo in the header.
50+
51+
- Supported file formats: PNG, JPG, JPEG, GIF, BMP
52+
- Maximum file size: 20 KB
53+
- Maximum dimensions: 150 by 30 pixels
54+
55+
After uploading the file, select the save icon to apply the logo.

docs/user-guide/management/lincense.md

Lines changed: 41 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The license defines the daily ingestion capacity for your OpenObserve installati
55

66
!!! note "Who can access"
77

8-
OpenObserve provides access to license information based on two roles. Your role decides what you can see and what actions you can perform.
8+
OpenObserve provides access to license information based on the following roles. Your role decides what you can see and what actions you can perform.
99

1010
| **Role** | **What you can do** | **What you cannot do** |
1111
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
@@ -17,41 +17,44 @@ The license defines the daily ingestion capacity for your OpenObserve installati
1717
## How to manage licenses
1818
To perform the following tasks, you must have appropriate permission. Review the **Who can access** section to know more.
1919

20-
### View license information
21-
![about-page](../../images/about-page-license.png)
22-
23-
1. Click the Help (?) icon in the top-right corner.
24-
2. Click **About**.
25-
2. In the **Enterprise License Details** section, review license status, ingestion limit, and daily usage.
26-
27-
### Request a new license
28-
29-
1. In the **Enterprise License Details** section of the **About** page, click **Manage License**.
30-
![about-page](../../images/about-page-license.png)
31-
2. It takes you to the License page under **Management** in the `_meta` organization.
32-
![license-management](../../images/license-management.png)
33-
3. Click **Request New License**.
34-
4. Complete the form by following the guidelines mentioned below and click **Submit Request**.
35-
36-
!!! note "Guideline for completing the license request form"
37-
Use the information below to complete each field accurately when requesting a new license through the License Server page.
38-
![license-server](../../images/license-server.png)
39-
40-
- **Installation ID**: The Installation ID field is usually prefilled by the system. If it is not prefilled, copy it from the License page under Management in the meta organization.
41-
- **Contact Name and Email Address**: Enter the name and email address of the primary contact person for your organization. This person will receive the license key and future communication related to license renewal or verification.
42-
- **Address**: Provide the official address of your organization. This must be a valid, complete postal address because it is used for verification and record keeping.
43-
- **Use case**: Describe how you plan to use OpenObserve. Provide clear details about your expected data volume or operational requirements.
44-
**Ingestion limit**: Select a limit based on the actual ingestion volume of your installation. To determine the correct value, review the usage stream in OpenObserve to identify your peak daily ingestion. Choose a limit that is higher than your highest observed ingestion volume to avoid data loss or ingestion failures.
45-
- **Additional email addresses**: List additional recipients who should receive notifications related to license issuance or updates.
46-
- **Base URLs**: Enter the base URLs used by your OpenObserve installation. The License Server accepts multiple base URLs because some installations may operate from more than one domain. Add each URL that users use to access your OpenObserve instance.
47-
48-
49-
### Add a new license key
50-
![add-new-license-key](../../images/add-new-license-key.png)
51-
52-
1. In the `_meta` organization, navigate to **Management** from the top-right corner.
53-
2. Select **License**.
54-
3. Select **Add New License Key**.
55-
4. Paste the license key in the **Update License Key** field.
56-
5. Select **Update License**.
20+
??? "View license information"
21+
### View license information
22+
![about-page](../../images/about-page-license.png)
23+
24+
1. Click the Help (?) icon in the top-right corner.
25+
2. Click **About**.
26+
2. In the **Enterprise License Details** section, review license status, ingestion limit, and daily usage.
27+
28+
??? "Request a new license"
29+
### Request a new license
30+
31+
1. In the **Enterprise License Details** section of the **About** page, click **Manage License**.
32+
![about-page](../../images/about-page-license.png)
33+
2. It takes you to the License page under **Management** in the `_meta` organization.
34+
![license-management](../../images/license-management.png)
35+
3. Click **Request New License**.
36+
4. Complete the form by following the guidelines mentioned below and click **Submit Request**.
37+
38+
!!! note "Guideline for completing the license request form"
39+
Use the information below to complete each field accurately when requesting a new license through the License Server page.
40+
![license-server](../../images/license-server.png)
41+
42+
- **Installation ID**: The Installation ID field is usually prefilled by the system. If it is not prefilled, copy it from the License page under Management in the meta organization.
43+
- **Contact Name and Email Address**: Enter the name and email address of the primary contact person for your organization. This person will receive the license key and future communication related to license renewal or verification.
44+
- **Address**: Provide the official address of your organization. This must be a valid, complete postal address because it is used for verification and record keeping.
45+
- **Use case**: Describe how you plan to use OpenObserve. Provide clear details about your expected data volume or operational requirements.
46+
- **Ingestion limit**: Select a limit based on the actual ingestion volume of your installation. To determine the correct value, review the usage stream in OpenObserve to identify your peak daily ingestion. Choose a limit that is higher than your highest observed ingestion volume to avoid data loss or ingestion failures.
47+
- **Additional email addresses**: List additional recipients who should receive notifications related to license issuance or updates.
48+
- **Base URLs**: Enter the base URLs used by your OpenObserve installation. The License Server accepts multiple base URLs because some installations may operate from more than one domain. Add each URL that users use to access your OpenObserve instance.
49+
50+
51+
??? "Add a new license key"
52+
### Add a new license key
53+
![add-new-license-key](../../images/add-new-license-key.png)
54+
55+
1. In the `_meta` organization, navigate to **Management** from the top-right corner.
56+
2. Select **License**.
57+
3. Select **Add New License Key**.
58+
4. Paste the license key in the **Update License Key** field.
59+
5. Select **Update License**.
5760

0 commit comments

Comments
 (0)