Commit d37252f7 authored by Rajendra Kadam's avatar Rajendra Kadam

Rename Usage Ping to Service Ping in 2 doc files

Rename Usage Data to Service Data in docs
parent 476be194
...@@ -170,7 +170,7 @@ The following API resources are available outside of project and group contexts ...@@ -170,7 +170,7 @@ The following API resources are available outside of project and group contexts
| [Suggestions](suggestions.md) | `/suggestions` | | [Suggestions](suggestions.md) | `/suggestions` |
| [System hooks](system_hooks.md) | `/hooks` | | [System hooks](system_hooks.md) | `/hooks` |
| [To-dos](todos.md) | `/todos` | | [To-dos](todos.md) | `/todos` |
| [Usage data](usage_data.md) | `/usage_data` (For GitLab instance [Administrator](../user/permissions.md) users only) | | [Service Data](usage_data.md) | `/usage_data` (For GitLab instance [Administrator](../user/permissions.md) users only) |
| [Users](users.md) | `/users` | | [Users](users.md) | `/users` |
| [Validate `.gitlab-ci.yml` file](lint.md) | `/lint` | | [Validate `.gitlab-ci.yml` file](lint.md) | `/lint` |
| [Version](version.md) | `/version` | | [Version](version.md) | `/version` |
......
...@@ -5,9 +5,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -5,9 +5,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w
type: reference, api type: reference, api
--- ---
# Usage Data API **(FREE SELF)** # Service Data API **(FREE SELF)**
The Usage Data API is associated with [Service Ping](../development/usage_ping/index.md). The Service Data API is associated with [Service Ping](../development/usage_ping/index.md).
## Export metric definitions as a single YAML file ## Export metric definitions as a single YAML file
......
...@@ -25,7 +25,7 @@ A database review is required for: ...@@ -25,7 +25,7 @@ A database review is required for:
generally up to the author of a merge request to decide whether or generally up to the author of a merge request to decide whether or
not complex queries are being introduced and if they require a not complex queries are being introduced and if they require a
database review. database review.
- Changes in usage data metrics that use `count`, `distinct_count` and `estimate_batch_distinct_count`. - Changes in Service Data metrics that use `count`, `distinct_count` and `estimate_batch_distinct_count`.
These metrics could have complex queries over large tables. These metrics could have complex queries over large tables.
See the [Product Intelligence Guide](https://about.gitlab.com/handbook/product/product-intelligence-guide/) See the [Product Intelligence Guide](https://about.gitlab.com/handbook/product/product-intelligence-guide/)
for implementation details. for implementation details.
......
...@@ -46,7 +46,7 @@ and can show your instance's usage statistics to your users. ...@@ -46,7 +46,7 @@ and can show your instance's usage statistics to your users.
We use the following terminology to describe the Service Ping components: We use the following terminology to describe the Service Ping components:
- **Service Ping**: the process that collects and generates a JSON payload. - **Service Ping**: the process that collects and generates a JSON payload.
- **Usage data**: the contents of the Service Ping JSON payload. This includes metrics. - **Service data**: the contents of the Service Ping JSON payload. This includes metrics.
- **Metrics**: primarily made up of row counts for different tables in an instance's database. Each - **Metrics**: primarily made up of row counts for different tables in an instance's database. Each
metric has a corresponding [metric definition](metrics_dictionary.md#metrics-definition-and-validation) metric has a corresponding [metric definition](metrics_dictionary.md#metrics-definition-and-validation)
in a YAML file. in a YAML file.
...@@ -882,9 +882,9 @@ We can also disable tracking completely by using the global flag: ...@@ -882,9 +882,9 @@ We can also disable tracking completely by using the global flag:
/chatops run feature set redis_hll_tracking false /chatops run feature set redis_hll_tracking false
``` ```
##### Known events are added automatically in usage data payload ##### Known events are added automatically in Service Data payload
All events added in [`known_events/common.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/usage_data_counters/known_events/common.yml) are automatically added to usage data generation under the `redis_hll_counters` key. This column is stored in [version-app as a JSON](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/master/db/schema.rb#L209). All events added in [`known_events/common.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/usage_data_counters/known_events/common.yml) are automatically added to Service Data generation under the `redis_hll_counters` key. This column is stored in [version-app as a JSON](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/master/db/schema.rb#L209).
For each event we add metrics for the weekly and monthly time frames, and totals for each where applicable: For each event we add metrics for the weekly and monthly time frames, and totals for each where applicable:
- `#{event_name}_weekly`: Data for 7 days for daily [aggregation](#adding-new-events) events and data for the last complete week for weekly [aggregation](#adding-new-events) events. - `#{event_name}_weekly`: Data for 7 days for daily [aggregation](#adding-new-events) events and data for the last complete week for weekly [aggregation](#adding-new-events) events.
...@@ -960,7 +960,7 @@ alt_usage_data(999) ...@@ -960,7 +960,7 @@ alt_usage_data(999)
### Adding counters to build new metrics ### Adding counters to build new metrics
When adding the results of two counters, use the `add` usage data method that When adding the results of two counters, use the `add` Service Data method that
handles fallback values and exceptions. It also generates a valid [SQL export](#exporting-service-ping-sql-queries-and-definitions). handles fallback values and exceptions. It also generates a valid [SQL export](#exporting-service-ping-sql-queries-and-definitions).
Example usage: Example usage:
...@@ -973,7 +973,7 @@ add(User.active, User.bot) ...@@ -973,7 +973,7 @@ add(User.active, User.bot)
In those cases where operational metrics should be part of Service Ping, a database or Redis query is unlikely In those cases where operational metrics should be part of Service Ping, a database or Redis query is unlikely
to provide useful data. Instead, Prometheus might be more appropriate, because most GitLab architectural to provide useful data. Instead, Prometheus might be more appropriate, because most GitLab architectural
components publish metrics to it that can be queried back, aggregated, and included as usage data. components publish metrics to it that can be queried back, aggregated, and included as Service Data.
NOTE: NOTE:
Prometheus as a data source for Service Ping is currently only available for single-node Omnibus installations Prometheus as a data source for Service Ping is currently only available for single-node Omnibus installations
...@@ -1074,7 +1074,7 @@ When adding, updating, or removing metrics, please update the [Metrics Dictionar ...@@ -1074,7 +1074,7 @@ When adding, updating, or removing metrics, please update the [Metrics Dictionar
### 6. Add new metric to Versions Application ### 6. Add new metric to Versions Application
Check if new metrics need to be added to the Versions Application. See `usage_data` [schema](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/master/db/schema.rb#L147) and usage data [parameters accepted](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/master/app/services/usage_ping.rb). Any metrics added under the `counts` key are saved in the `stats` column. Check if new metrics need to be added to the Versions Application. See `usage_data` [schema](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/master/db/schema.rb#L147) and Service Data [parameters accepted](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/master/app/services/usage_ping.rb). Any metrics added under the `counts` key are saved in the `stats` column.
### 7. Add the feature label ### 7. Add the feature label
......
...@@ -15,7 +15,7 @@ This guide describes how to develop Service Ping metrics using metrics instrumen ...@@ -15,7 +15,7 @@ This guide describes how to develop Service Ping metrics using metrics instrumen
- Implements the logic that calculates the value for a Service Ping metric. - Implements the logic that calculates the value for a Service Ping metric.
- **Metric definition** - **Metric definition**
The Usage Data metric YAML definition. The Service Data metric YAML definition.
- **Hardening**: - **Hardening**:
Hardening a method is the process that ensures the method fails safe, returning a fallback value like -1. Hardening a method is the process that ensures the method fails safe, returning a fallback value like -1.
......
...@@ -46,7 +46,7 @@ The following Rake tasks are available for use with GitLab: ...@@ -46,7 +46,7 @@ The following Rake tasks are available for use with GitLab:
| [Repository storage](../administration/raketasks/storage.md) | List and migrate existing projects and attachments from legacy storage to hashed storage. | | [Repository storage](../administration/raketasks/storage.md) | List and migrate existing projects and attachments from legacy storage to hashed storage. |
| [Uploads migrate](../administration/raketasks/uploads/migrate.md) | Migrate uploads between local storage and object storage. | | [Uploads migrate](../administration/raketasks/uploads/migrate.md) | Migrate uploads between local storage and object storage. |
| [Uploads sanitize](../administration/raketasks/uploads/sanitize.md) | Remove EXIF data from images uploaded to earlier versions of GitLab. | | [Uploads sanitize](../administration/raketasks/uploads/sanitize.md) | Remove EXIF data from images uploaded to earlier versions of GitLab. |
| [Usage data](../administration/troubleshooting/gitlab_rails_cheat_sheet.md#generate-service-ping) | Generate and troubleshoot [Service Ping](../development/usage_ping/index.md). | | [Service Data](../administration/troubleshooting/gitlab_rails_cheat_sheet.md#generate-service-ping) | Generate and troubleshoot [Service Ping](../development/usage_ping/index.md). |
| [User management](user_management.md) | Perform user management tasks. | | [User management](user_management.md) | Perform user management tasks. |
| [Webhooks administration](web_hooks.md) | Maintain project webhooks. | | [Webhooks administration](web_hooks.md) | Maintain project webhooks. |
| [X.509 signatures](x509_signatures.md) | Update X.509 commit signatures, which can be useful if the certificate store changed. | | [X.509 signatures](x509_signatures.md) | Update X.509 commit signatures, which can be useful if the certificate store changed. |
...@@ -86,7 +86,7 @@ To access the default page for Admin Area settings: ...@@ -86,7 +86,7 @@ To access the default page for Admin Area settings:
| [Metrics - Grafana](../../../administration/monitoring/performance/grafana_configuration.md#integration-with-gitlab-ui) | Enable and configure Grafana. | | [Metrics - Grafana](../../../administration/monitoring/performance/grafana_configuration.md#integration-with-gitlab-ui) | Enable and configure Grafana. |
| [Profiling - Performance bar](../../../administration/monitoring/performance/performance_bar.md#enable-the-performance-bar-via-the-admin-area) | Enable access to the Performance Bar for a given group. | | [Profiling - Performance bar](../../../administration/monitoring/performance/performance_bar.md#enable-the-performance-bar-via-the-admin-area) | Enable access to the Performance Bar for a given group. |
| [Self monitoring](../../../administration/monitoring/gitlab_self_monitoring_project/index.md#creating-the-self-monitoring-project) | Enable or disable instance self monitoring. | | [Self monitoring](../../../administration/monitoring/gitlab_self_monitoring_project/index.md#creating-the-self-monitoring-project) | Enable or disable instance self monitoring. |
| [Usage statistics](usage_statistics.md) | Enable or disable version check and usage ping. | | [Usage statistics](usage_statistics.md) | Enable or disable version check and Service Ping. |
| [Pseudonymizer data collection](../../../administration/pseudonymizer.md) **(ULTIMATE)** | Enable or disable the Pseudonymizer data collection. | | [Pseudonymizer data collection](../../../administration/pseudonymizer.md) **(ULTIMATE)** | Enable or disable the Pseudonymizer data collection. |
## Network ## Network
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment