Skip to content

Commit 873f1e2

Browse files
committed
PMM-9146 provide an endpoint to modify custom labels
1 parent 702da4d commit 873f1e2

File tree

1 file changed

+8
-6
lines changed
  • documentation/docs/admin/roles/access-control

1 file changed

+8
-6
lines changed

documentation/docs/admin/roles/access-control/labels.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ With label-based access control, you can associate multiple labels with a role,
88

99
## Standard vs custom labels
1010

11-
PMM supports standard as well as custom labels. When the user adds a service to monitoring, PMM automatically assigns some standard labels. Thease labels are mostly based on the type of service being added to monitoring, such as `service_type`, `agent_type`, `node_name`, etc. Some other labels are auto-generated by PMM, for example, `service_id`, `node_id`, etc. Normally, the user can override standard labels when an object –– Node, Service, or Agent –– is created. There is also a possibility to define custom labels when adding objects. Custom labels, however, are assigned and updated only by the user.
11+
PMM supports standard as well as custom labels. When the user adds a service to monitoring, PMM automatically assigns some standard labels. Thease labels are mostly based on the type of service being added to monitoring, such as `service_type`, `agent_type`, `node_name`, etc. Some other labels are auto-generated by PMM, for example, `service_id`, `node_id`, etc. Normally, the user can override standard labels when an object — Node, Service, or Agent — is created. There is also a possibility to define custom labels when adding objects. Custom labels, however, are assigned and updated only by the user.
1212

1313
It's important to note that standard labels are not always available for all objects. For example, the `service_type` label is only available for services, while the `agent_type` label is only available for agents.
1414

@@ -17,20 +17,22 @@ Both standard and custom labels are persisted during the metrics collection proc
1717
**Examples**
1818

1919
| **Label Type**| **Object**| **Label name ** | **Example** |
20-
|---------------|-----------|-----------------|-------------|
21-
| **Standard** | Node | node_id | 123 |
22-
| **Standard** | Service | service_type | mysql, mongodb, postgresql etc. |
20+
|---------------|-----------|-----------------|--------------------------------------|
21+
| **Standard** | Node | node_id | 5bdfb1b4-c6c4-4086-83a2-e8daa0b84d4b |
22+
| **Standard** | Service | service_type | mysql, mongodb, postgresql etc. |
2323
| **Custom** | Node, Service, Agent | Any string matching the regular expression: <br /> [a-zA-Z_][a-zA-Z0-9_]*. <br /> Also, it cannot start with two underscores.| owner="joe"<br/> _rack="12345"|
2424

2525
## Assigning labels
2626

27-
You can assign custom or standard labels while adding a service to monitoring in PMM.
27+
You can assign standard or custom labels while adding a service to monitoring in PMM.
2828

2929
## Modifying labels
3030

3131
Currently, PMM does not support modifying standard labels. To modify a standard label, you first need to remove the service and re-add it with a new set of standard labels.
3232

33-
However, you can modify custom labels.
33+
However, you can modify custom labels of a service via an [API endpoint](https://percona-pmm.readme.io/reference/changeservice).
34+
35+
```bash
3436

3537
### Using PMM UI
3638

0 commit comments

Comments
 (0)