2024-05-21: Enable OpenTelemetry observability on staging environment
Production Change
Change Summary
Related to gitlab-com/observability/staging#1 (closed)
Enable sending traces from staging.gitlab.com to observe.gitlab.com.
In Enable OpenTelemetry for non-prod environments (gitlab-org/gitlab!148695 - merged), we added OpenTelemetry instrumentation on the app, and support for enabling it in development
and staging
environments, via ENV vars.
This issue is to track the work to set those ENV vars in the staging environment in order to enable it there.
The process and steps will be very similar to this process for setting it up in a local development GDK environment: https://docs.gitlab.com/ee/development/stage_group_observability/gitlab_instrumentation_for_opentelemetry.html
The OpenTelemetry exporters will be configured to point at the https://gitlab.com/gitlab-com/observability/staging project in the https://gitlab.com/gitlab-com root namespace:
-
https://gitlab.com/gitlab-com/observability/staging, project ID
56968592
-
https://gitlab.com/gitlab-com, namespace/group ID
6543
Change Details
- Services Impacted - GitLab Monolith on staging
- Change Technician - @jarv
- Change Reviewer - @jarv
- Time tracking - unknown
- Downtime Component - none
Set Maintenance Mode in GitLab
If your change involves scheduled maintenance, add a step to set and unset maintenance mode per our runbooks. This will make sure SLA calculations adjust for the maintenance period.
Detailed steps for the change
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - Estimated Time to Complete in Minutes
-
Set label changein-progress /label ~change::in-progress
-
Create an access token as described in https://docs.gitlab.com/ee/operations/tracing.html#create-an-access-token, add it to the appropriate vault (1Password? Not sure of the process here), make a note of its vault location here.
-
Set the following ENV vars in the staging
environment gitlab-com/gl-infra/k8s-workloads/gitlab-com!3601 (merged)
GITLAB_ENABLE_OTEL_EXPORTERS=true
OTEL_EXPORTER=otlphttp
OTEL_SERVICE_NAME="gitlab-rails-staging"
OTEL_EXPORTER_OTLP_HEADERS="PRIVATE-TOKEN=<token created in step above>"
OTEL_EXPORTER_OTLP_ENDPOINT="https://observe.gitlab.com/v3/6543/56968592/ingest"
-
Restart staging ENV to pick up the ENV vars -
-
View https://gitlab.com/gitlab-com/observability/staging/-/tracing?period[]=1h&sortBy=timestamp_desc and ensure tracing data is showing up -
Observe performance/availability of staging to ensure there is no negative impact
-
Set label changecomplete /label ~change::complete
Rollback
Rollback steps - steps to be taken in the event of a need to rollback this change
Estimated Time to Complete (mins) - Estimated Time to Complete in Minutes
-
Rollback Step 1 -
Rollback Step 2 -
Set label changeaborted /label ~change::aborted
Monitoring
Key metrics to observe
- Metric: Metric Name
- Location: Dashboard URL
- What changes to this metric should prompt a rollback: Describe Changes
Change Reviewer checklist
-
Check if the following applies: - The scheduled day and time of execution of the change is appropriate.
- The change plan is technically accurate.
- The change plan includes estimated timing values based on previous testing.
- The change plan includes a viable rollback plan.
- The specified metrics/monitoring dashboards provide sufficient visibility for the change.
-
Check if the following applies: - The complexity of the plan is appropriate for the corresponding risk of the change. (i.e. the plan contains clear details).
- The change plan includes success measures for all steps/milestones during the execution.
- The change adequately minimizes risk within the environment/service.
- The performance implications of executing the change are well-understood and documented.
- The specified metrics/monitoring dashboards provide sufficient visibility for the change.
- If not, is it possible (or necessary) to make changes to observability platforms for added visibility?
- The change has a primary and secondary SRE with knowledge of the details available during the change window.
- The change window has been agreed with Release Managers in advance of the change. If the change is planned for APAC hours, this issue has an agreed pre-change approval.
- The labels blocks deployments and/or blocks feature-flags are applied as necessary.
Change Technician checklist
-
Check if all items below are complete: - The change plan is technically accurate.
- This Change Issue is linked to the appropriate Issue and/or Epic
- Change has been tested in staging and results noted in a comment on this issue.
- A dry-run has been conducted and results noted in a comment on this issue.
- The change execution window respects the Production Change Lock periods.
- For C1 and C2 change issues, the change event is added to the GitLab Production calendar.
- For C1 and C2 change issues, the SRE on-call has been informed prior to change being rolled out. (In #production channel, mention
@sre-oncall
and this issue and await their acknowledgement.) - For C1 and C2 change issues, the SRE on-call provided approval with the eoc_approved label on the issue.
- For C1 and C2 change issues, the Infrastructure Manager provided approval with the manager_approved label on the issue.
- Release managers have been informed prior to any C1, C2, or blocks deployments change being rolled out. (In #production channel, mention
@release-managers
and this issue and await their acknowledgment.) - There are currently no active incidents that are severity1 or severity2
- If the change involves doing maintenance on a database host, an appropriate silence targeting the host(s) should be added for the duration of the change.