Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add test insights #985

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add test insights #985

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/content/admin/okteto-insights.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ As part of Okteto Insights, we are offering the following metric groupings:
- [Deploy Metrics](#deploy-metrics): Information on Deploy times and results by environment
- [Namespace Metrics](#namespace-metrics): Information on the Sleeping and Awake Namespaces
- [Preview Metrics](#preview-metrics): Information on Sleeping and Awake Preview Environments
- [Test Metrics](#test-metrics): Information on test times and results by environment
- [User Metrics](#user-metrics): Information on User activity

:::note
Expand Down Expand Up @@ -201,6 +202,25 @@ Only successful deployments are tracked with `okteto_usage_deploy_duration_secon
- **`scope`**: Represents the scope of the preview, values can be `personal` or `global`
- **`owner_id`**: Represents the owner ID of the preview

### Test Metrics

:::note
Only successful tests are tracked with `okteto_usage_test_duration_seconds`.
:::

| Metric Name | Type | Description | Labels |
| :----------- | :----------- | :----------- | :----------- |
| `okteto_usage_test_duration_seconds` | [histogram](https://prometheus.io/docs/practices/histograms/) | This represents metrics related to the time it takes to execute a test container. This metric only show tests that have successfully completed. | `devenv_name`, `namespace`, `repository`, `test_name` |
| `okteto_usage_test_result` | [counter](https://prometheus.io/docs/concepts/metric_types/#counter) | This represents metrics related to the result of the tests of a development environment. | `devenv_name`, `namespace`, `repository`, `test_name`, `result` |

- **Test Metrics label definitions:**
- **`devenv_name`**: Represents the name of the development environment.
- **`namespace`**: Contains the okteto cli context from where the request originated.
- **`repository`**: Contains the git repository where the okteto manifest that defines this development environment is hosted.
- **`test_name`**: Represents the test container being executed.
- **`result`**: Can be `success` or `failure` to represent the status of the test container.


### User Metrics

| Metric Name | Type | Description | Labels |
Expand Down