Skip to content

Commit

Permalink
[8.x] [Observability Onboarding] Adjust wording for instrumentation a…
Browse files Browse the repository at this point in the history 
…nd doc links (#198164) (#198468)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Observability Onboarding] Adjust wording for instrumentation and doc
links (#198164)](#198164)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Joe
Reuter","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-30T09:18:59Z","message":"[Observability
Onboarding] Adjust wording for instrumentation and doc links
(#198164)\n\nCloses
https://github.com/elastic/kibana/issues/197620\r\n\r\n\r\n![Image](https://github.com/user-attachments/assets/e94dd9ff-bd5b-49a6-9b39-fdf54a4e3e58)\r\n\r\n*
Newly introduced cert-manager doc link goes
to\r\nhttps://ela.st/8-16-otel-cert-manager\r\n* Instrumentation docs
link goes to\r\nhttps://ela.st/8-16-otel-apm-instrumentation\r\n* Code
sample for instrumentation
replaced\r\n\r\n---------\r\n\r\nCo-authored-by: Mykola Harmash
<[email protected]>","sha":"03c8c4a9cc8144584f2410c753dea2d01b724a82","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-logs","Feature:
Observability Onboarding","v8.16.0"],"title":"[Observability Onboarding]
Adjust wording for instrumentation and doc
links","number":198164,"url":"https://github.com/elastic/kibana/pull/198164","mergeCommit":{"message":"[Observability
Onboarding] Adjust wording for instrumentation and doc links
(#198164)\n\nCloses
https://github.com/elastic/kibana/issues/197620\r\n\r\n\r\n![Image](https://github.com/user-attachments/assets/e94dd9ff-bd5b-49a6-9b39-fdf54a4e3e58)\r\n\r\n*
Newly introduced cert-manager doc link goes
to\r\nhttps://ela.st/8-16-otel-cert-manager\r\n* Instrumentation docs
link goes to\r\nhttps://ela.st/8-16-otel-apm-instrumentation\r\n* Code
sample for instrumentation
replaced\r\n\r\n---------\r\n\r\nCo-authored-by: Mykola Harmash
<[email protected]>","sha":"03c8c4a9cc8144584f2410c753dea2d01b724a82"}},"sourceBranch":"main","suggestedTargetBranches":["8.16"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/198164","number":198164,"mergeCommit":{"message":"[Observability
Onboarding] Adjust wording for instrumentation and doc links
(#198164)\n\nCloses
https://github.com/elastic/kibana/issues/197620\r\n\r\n\r\n![Image](https://github.com/user-attachments/assets/e94dd9ff-bd5b-49a6-9b39-fdf54a4e3e58)\r\n\r\n*
Newly introduced cert-manager doc link goes
to\r\nhttps://ela.st/8-16-otel-cert-manager\r\n* Instrumentation docs
link goes to\r\nhttps://ela.st/8-16-otel-apm-instrumentation\r\n* Code
sample for instrumentation
replaced\r\n\r\n---------\r\n\r\nCo-authored-by: Mykola Harmash
<[email protected]>","sha":"03c8c4a9cc8144584f2410c753dea2d01b724a82"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Joe Reuter <[email protected]>
  • Loading branch information
@kibanamachine @flash1293
kibanamachine and flash1293 authored Oct 31, 2024
1 parent 40c5cdd commit eb25a3d
Showing 1 changed file with 40 additions and 12 deletions.
52 changes: 40 additions & 12 deletions ..._onboarding/public/application/quickstart_flows/otel_kubernetes/otel_kubernetes_panel.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ helm install opentelemetry-kube-stack open-telemetry/opentelemetry-kube-stack \\
<p>
<FormattedMessage
id="xpack.observability_onboarding.otelKubernetesPanel.injectAutoinstrumentationLibrariesForLabel"
defaultMessage="Install the OpenTelemetry Operator using the kube-stack Helm chart and the provided values file. For automatic certificate renewal, we recommend installing the {link}."
defaultMessage="Install the OpenTelemetry Operator using the kube-stack Helm chart and the provided values file. For automatic certificate renewal, we recommend installing the {link}, and customize the values.yaml file before the installation as described {doc}."
values={{
link: (
<EuiLink
Expand All @@ -115,6 +115,18 @@ helm install opentelemetry-kube-stack open-telemetry/opentelemetry-kube-stack \\
)}
</EuiLink>
),
doc: (
<EuiLink
href="https://ela.st/8-16-otel-cert-manager"
target="_blank"
data-test-subj="observabilityOnboardingOtelKubernetesPanelCertManagerDocsLink"
>
{i18n.translate(
'xpack.observability_onboarding.otelKubernetesPanel.certmanagerDocsLinkLabel',
{ defaultMessage: 'in our documentation' }
)}
</EuiLink>
),
}}
/>{' '}
<EuiIconTip
Expand Down Expand Up @@ -175,7 +187,7 @@ helm install opentelemetry-kube-stack open-telemetry/opentelemetry-kube-stack \\
'xpack.observability_onboarding.otelKubernetesPanel.theOperatorAutomatesTheLabel',
{
defaultMessage:
'The Operator automates the injection of auto-instrumentation libraries into the annotated pods for some languages.',
'Enable automatic instrumentation for your applications by annotating the pods template (spec.template.metadata.annotations) in your Deployment or relevant workload object (StatefulSet, Job, CronJob, etc.)',
}
)}
</p>
Expand Down Expand Up @@ -213,17 +225,33 @@ helm install opentelemetry-kube-stack open-telemetry/opentelemetry-kube-stack \\
]}
/>
<EuiSpacer />
<EuiCodeBlock paddingSize="m" language="yaml" lineNumbers={{ highlight: '5-6' }}>
{`apiVersion: v1
kind: Pod
<EuiCodeBlock paddingSize="m" language="yaml">
{`# To annotate specific deployment Pods modify its manifest
apiVersion: apps/v1
kind: Deployment
metadata:
name: my-app
annotations:
instrumentation.opentelemetry.io/inject-${idSelected}: "${namespace}/elastic-instrumentation"
name: myapp
spec:
containers:
- name: my-app
image: my-app:latest`}
...
template:
metadata:
annotations:
instrumentation.opentelemetry.io/inject-${idSelected}: "${namespace}/elastic-instrumentation"
...
spec:
containers:
- image: myapplication-image
name: app
...
# To annotate all resources in a namespace
kubectl annotate namespace my-namespace instrumentation.opentelemetry.io/inject-${idSelected}: "${namespace}/elastic-instrumentation"
# Restart your deployment
kubectl rollout restart deployment myapp -n my-namespace
# Check annotations have been applied correctly and auto-instrumentation library is injected
kubectl describe pod <myapp-pod-name> -n my-namespace`}
</EuiCodeBlock>
<EuiSpacer />
<CopyToClipboardButton
Expand All @@ -239,7 +267,7 @@ spec:
values={{
link: (
<EuiLink
href={`/path`}
href="https://ela.st/8-16-otel-apm-instrumentation"
data-test-subj="observabilityOnboardingOtelKubernetesPanelReferToTheDocumentationLink"
target="_blank"
>
Expand Down

0 comments on commit eb25a3d

Please sign in to comment.