프로세스

1. OpenTelemetry Operator의 Red Hat 빌드를 설치합니다.

   1. Operators → OperatorHub 로 이동하여 OpenTelemetry Operator의 Red Hat 빌드를 검색합니다.

   2. Red Hat → Install → Install → View Operator 에서 제공하는 OpenTelemetry Operator의 Red Hat 빌드 를 선택합니다.

      중요

      이렇게 하면 기본 사전 설정을 사용하여 Operator가 설치됩니다.

      • 업데이트 채널 → stable
      • 설치 모드 → 클러스터의 모든 네임스페이스
      • 설치된 네임스페이스 → openshift-operators
      • 업데이트 승인 → 자동
   3. 설치된 Operator 페이지의 세부 정보 탭에서 ClusterServiceVersion 세부 정보 에서 설치 상태가 Succeeded인지 확인합니다.
2. 홈 → 프로젝트 → 프로젝트 생성으로 이동하여 다음 단계에서 생성할 OpenTelemetry 수집기 인스턴스에 대해 선택한 프로젝트를 생성합니다.

3. OpenTelemetry 수집기 인스턴스를 생성합니다.

   1. Operator → 설치된 Operator 로 이동합니다.
   2. OpenTelemetry Collector → OpenTelemetry 수집기 → YAML 보기를 선택합니다.

   3. YAML 보기에서 OTLP, Jaeger, Zipkin 수신기 및 디버그 내보내기를 사용하여 OpenTelemetryCollector CR(사용자 정의 리소스)을 사용자 지정합니다.

      apiVersion: opentelemetry.io/v1alpha1
      kind: OpenTelemetryCollector
      metadata:
        name: otel
        namespace: <project_of_opentelemetry_collector_instance>
      spec:
        mode: deployment
        config: |
          receivers:
            otlp:
              protocols:
                grpc:
                http:
            jaeger:
              protocols:
                grpc:
                thrift_binary:
                thrift_compact:
                thrift_http:
            zipkin:
          processors:
            batch:
            memory_limiter:
              check_interval: 1s
              limit_percentage: 50
              spike_limit_percentage: 30
          exporters:
            debug:
          service:
            pipelines:
              traces:
                receivers: [otlp,jaeger,zipkin]
                processors: [memory_limiter,batch]
                exporters: [debug]

   4. 생성을 선택합니다.

검증

1. Project: 드롭다운 목록을 사용하여 OpenTelemetry 수집기 인스턴스의 프로젝트를 선택합니다.
2. Operator → 설치된 Operator로 이동하여 OpenTelemetry 수집기 인스턴스의 상태가 Condition: Ready 인지 확인합니다.
3. 워크로드 → Pod 로 이동하여 OpenTelemetry 수집기 인스턴스의 모든 구성 요소 Pod가 실행 중인지 확인합니다.

프로세스

1. OpenTelemetry Operator의 Red Hat 빌드를 설치합니다.

   1. 다음 명령을 실행하여 Red Hat build of OpenTelemetry Operator 프로젝트를 생성합니다.

      $ oc apply -f - << EOF
      apiVersion: project.openshift.io/v1
      kind: Project
      metadata:
        labels:
          kubernetes.io/metadata.name: openshift-opentelemetry-operator
          openshift.io/cluster-monitoring: "true"
        name: openshift-opentelemetry-operator
      EOF

   2. 다음 명령을 실행하여 Operator group을 생성합니다.

      $ oc apply -f - << EOF
      apiVersion: operators.coreos.com/v1
      kind: OperatorGroup
      metadata:
        name: openshift-opentelemetry-operator
        namespace: openshift-opentelemetry-operator
      spec:
        upgradeStrategy: Default
      EOF

   3. 다음 명령을 실행하여 서브스크립션을 생성합니다.

      $ oc apply -f - << EOF
      apiVersion: operators.coreos.com/v1alpha1
      kind: Subscription
      metadata:
        name: opentelemetry-product
        namespace: openshift-opentelemetry-operator
      spec:
        channel: stable
        installPlanApproval: Automatic
        name: opentelemetry-product
        source: redhat-operators
        sourceNamespace: openshift-marketplace
      EOF

   4. 다음 명령을 실행하여 Operator 상태를 확인합니다.

      $ oc get csv -n openshift-opentelemetry-operator

2. 후속 단계에서 생성할 OpenTelemetry 수집기 인스턴스에 대해 선택한 프로젝트를 생성합니다.

   • 메타데이터 없이 프로젝트를 생성하려면 다음 명령을 실행합니다.

     $ oc new-project <project_of_opentelemetry_collector_instance>

   • 메타데이터로 프로젝트를 생성하려면 다음 명령을 실행합니다.

     $ oc apply -f - << EOF
     apiVersion: project.openshift.io/v1
     kind: Project
     metadata:
       name: <project_of_opentelemetry_collector_instance>
     EOF

3. 사용자가 생성한 프로젝트에서 OpenTelemetry 수집기 인스턴스를 생성합니다.

   참고

   동일한 클러스터의 별도의 프로젝트에서 여러 OpenTelemetry 수집기 인스턴스를 생성할 수 있습니다.

   1. OTLP, Jaeger 및 Zipkin 수신기 및 디버그 내보내기를 사용하여 OpenTelemetry 수집기 CR(사용자 정의 리소스)을 사용자 지정합니다.

      apiVersion: opentelemetry.io/v1alpha1
      kind: OpenTelemetryCollector
      metadata:
        name: otel
        namespace: <project_of_opentelemetry_collector_instance>
      spec:
        mode: deployment
        config: |
          receivers:
            otlp:
              protocols:
                grpc:
                http:
            jaeger:
              protocols:
                grpc:
                thrift_binary:
                thrift_compact:
                thrift_http:
            zipkin:
          processors:
            batch:
            memory_limiter:
              check_interval: 1s
              limit_percentage: 50
              spike_limit_percentage: 30
          exporters:
            debug:
          service:
            pipelines:
              traces:
                receivers: [otlp,jaeger,zipkin]
                processors: [memory_limiter,batch]
                exporters: [debug]

   2. 다음 명령을 실행하여 사용자 지정된 CR을 적용합니다.

      $ oc apply -f - << EOF
      <OpenTelemetryCollector_custom_resource>
      EOF

검증

1. 다음 명령을 실행하여 OpenTelemetry 수집기 Pod의 status.phase 이 Running 이고 conditions가 type: Ready 인지 확인합니다.

   $ oc get pod -l app.kubernetes.io/managed-by=opentelemetry-operator,app.kubernetes.io/instance=<namespace>.<instance_name> -o yaml

2. 다음 명령을 실행하여 OpenTelemetry 수집기 서비스를 가져옵니다.

   $ oc get service -l app.kubernetes.io/managed-by=opentelemetry-operator,app.kubernetes.io/instance=<namespace>.<instance_name>

프로세스

1. OpenTelemetry 수집기 인스턴스에 대한 프로젝트를 생성합니다.

   apiVersion: project.openshift.io/v1
   kind: Project
   metadata:
     name: observability

2. 서비스 계정을 생성합니다.

   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: otel-collector-sidecar
     namespace: observability

3. k8sattributes 및 resourcedetection 프로세서에 대한 서비스 계정에 권한을 부여합니다.

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: otel-collector
   rules:
   - apiGroups: ["", "config.openshift.io"]
     resources: ["pods", "namespaces", "infrastructures", "infrastructures/status"]
     verbs: ["get", "watch", "list"]
   ---
   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: otel-collector
   subjects:
   - kind: ServiceAccount
     name: otel-collector-sidecar
     namespace: observability
   roleRef:
     kind: ClusterRole
     name: otel-collector
     apiGroup: rbac.authorization.k8s.io

4. OpenTelemetry Collector를 사이드카로 배포합니다.

   apiVersion: opentelemetry.io/v1alpha1
   kind: OpenTelemetryCollector
   metadata:
     name: otel
     namespace: observability
   spec:
     serviceAccount: otel-collector-sidecar
     mode: sidecar
     config: |
       serviceAccount: otel-collector-sidecar
       receivers:
         otlp:
           protocols:
             grpc:
             http:
       processors:
         batch:
         memory_limiter:
           check_interval: 1s
           limit_percentage: 50
           spike_limit_percentage: 30
         resourcedetection:
           detectors: [openshift]
           timeout: 2s
       exporters:
         otlp:
           endpoint: "tempo-<example>-gateway:8090" 1
           tls:
             insecure: true
       service:
         pipelines:
           traces:
             receivers: [jaeger]
             processors: [memory_limiter, resourcedetection, batch]
             exporters: [otlp]

   1

   이는 Tempo Operator를 사용하여 <example> 배포된 TempoStack 인스턴스의 게이트웨이를 가리킵니다.

5. otel-collector-sidecar 서비스 계정을 사용하여 배포를 생성합니다.
6. Deployment 오브젝트에 sidecar.opentelemetry.io/inject: "true" 주석을 추가합니다. 이렇게 하면 워크로드에서 OpenTelemetry 수집기 인스턴스로 데이터를 보내는 데 필요한 모든 환경 변수가 삽입됩니다.

프로세스

1. OpenTelemetry 수집기 인스턴스에 대한 프로젝트를 생성합니다.

   apiVersion: project.openshift.io/v1
   kind: Project
   metadata:
     name: observability

2. 서비스 계정을 생성합니다.

   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: otel-collector-deployment
     namespace: observability

3. k8sattributes 및 resourcedetection 프로세서에 대한 서비스 계정에 권한을 부여합니다.

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: otel-collector
   rules:
   - apiGroups: ["", "config.openshift.io"]
     resources: ["pods", "namespaces", "infrastructures", "infrastructures/status"]
     verbs: ["get", "watch", "list"]
   ---
   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: otel-collector
   subjects:
   - kind: ServiceAccount
     name: otel-collector
     namespace: observability
   roleRef:
     kind: ClusterRole
     name: otel-collector
     apiGroup: rbac.authorization.k8s.io

4. OpenTelemetryCollector 사용자 정의 리소스를 사용하여 OpenTelemetry 수집기 인스턴스를 배포합니다.

   apiVersion: opentelemetry.io/v1alpha1
   kind: OpenTelemetryCollector
   metadata:
     name: otel
     namespace: observability
   spec:
     mode: deployment
     serviceAccount: otel-collector-deployment
     config: |
       receivers:
         jaeger:
           protocols:
             grpc:
             thrift_binary:
             thrift_compact:
             thrift_http:
         opencensus:
         otlp:
           protocols:
             grpc:
             http:
         zipkin:
       processors:
         batch:
         k8sattributes:
         memory_limiter:
           check_interval: 1s
           limit_percentage: 50
           spike_limit_percentage: 30
         resourcedetection:
           detectors: [openshift]
       exporters:
         otlp:
           endpoint: "tempo-<example>-distributor:4317" 1
           tls:
             insecure: true
       service:
         pipelines:
           traces:
             receivers: [jaeger, opencensus, otlp, zipkin]
             processors: [memory_limiter, k8sattributes, resourcedetection, batch]
             exporters: [otlp]

   1

   이는 Tempo Operator를 사용하여 <example> 배포된 TempoStack 인스턴스의 게이트웨이를 가리킵니다.

5. 조정된 애플리케이션을 사용하여 컨테이너의 환경 변수를 설정합니다.

   이름	설명	기본값
   OTEL_SERVICE_NAME	service.name 리소스 속성 값을 설정합니다.	""
   OTEL_EXPORTER_OTLP_ENDPOINT	선택적으로 지정된 포트 번호가 있는 모든 신호 유형의 기본 끝점 URL입니다.	https://localhost:4317
   OTEL_EXPORTER_OTLP_CERTIFICATE	gRPC 클라이언트의 TLS 자격 증명에 대한 인증서 파일의 경로입니다.	https://localhost:4317
   OTEL_TRACES_SAMPLER	추적에 사용할 샘플입니다.	parentbased_always_on
   OTEL_EXPORTER_OTLP_PROTOCOL	OTLP 내보내기를 위한 전송 프로토콜입니다.	grpc
   OTEL_EXPORTER_OTLP_TIMEOUT	OTLP 내보내기가 각 배치 내보내기에 대해 대기하는 최대 시간 간격입니다.	10s
   OTEL_EXPORTER_OTLP_INSECURE	gRPC 요청에 대한 클라이언트 전송 보안을 비활성화합니다. HTTPS 스키마는 이를 덮어씁니다.	False

프로세스

1. OpenTelemetryCollector 사용자 정의 리소스(CR)에서 관련 로그 수준을 설정합니다.

     config: |
       service:
         telemetry:
           logs:
             level: debug 1

   1

   수집기의 로그 수준입니다. 지원되는 값에는 info,warn,error 또는 debug 가 있습니다. 기본값은 info 입니다.

2. oc logs 명령 또는 웹 콘솔을 사용하여 로그를 검색합니다.

프로세스

1. OpenTelemetryCollector 사용자 정의 리소스에 다음 행을 추가하여 Telemetry 서비스를 활성화합니다.

     config: |
       service:
         telemetry:
           metrics:
             address: ":8888" 1

   1

   내부 수집기 지표가 노출되는 주소입니다. 기본값은 :8888 입니다.

1. port-forwarding Collector Pod를 사용하는 다음 명령을 실행하여 지표를 검색합니다.

   $ oc port-forward <collector_pod>

2. http://localhost:8888/metrics 의 메트릭 끝점에 액세스합니다.

프로세스

1. 다음과 같이 OpenTelemetryCollector 사용자 정의 리소스를 구성합니다.

     config: |
       exporters:
         debug:
           verbosity: detailed
       service:
         pipelines:
           traces:
             exporters: [debug]
           metrics:
             exporters: [debug]
           logs:
             exporters: [debug]

2. oc logs 명령 또는 웹 콘솔을 사용하여 로그를 표준 출력으로 내보냅니다.

프로세스

1. OpenTelemetry 수집기를 사이드카로 구성합니다.

   apiVersion: opentelemetry.io/v1alpha1
   kind: OpenTelemetryCollector
   metadata:
     name: otel
     namespace: <otel-collector-namespace>
   spec:
     mode: sidecar
     config: |
       receivers:
         jaeger:
           protocols:
             grpc:
             thrift_binary:
             thrift_compact:
             thrift_http:
       processors:
         batch:
         memory_limiter:
           check_interval: 1s
           limit_percentage: 50
           spike_limit_percentage: 30
         resourcedetection:
           detectors: [openshift]
           timeout: 2s
       exporters:
         otlp:
           endpoint: "tempo-<example>-gateway:8090" 1
           tls:
             insecure: true
       service:
         pipelines:
           traces:
             receivers: [jaeger]
             processors: [memory_limiter, resourcedetection, batch]
             exporters: [otlp]

   1

   이 끝점은 Tempo Operator를 사용하여 배포된 TempoStack 인스턴스의 게이트웨이를 <example> 가리킵니다.

2. 애플리케이션 실행을 위한 서비스 계정을 생성합니다.

   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: otel-collector-sidecar

3. 일부 프로세서에 필요한 권한에 대한 클러스터 역할을 생성합니다.

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: otel-collector-sidecar
   rules:
     1
   - apiGroups: ["config.openshift.io"]
     resources: ["infrastructures", "infrastructures/status"]
     verbs: ["get", "watch", "list"]

   1

   resourcedetectionprocessor에는 인프라 및 인프라/상태에 대한 권한이 필요합니다.

4. ClusterRoleBinding 을 생성하여 서비스 계정에 대한 권한을 설정합니다.

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: otel-collector-sidecar
   subjects:
   - kind: ServiceAccount
     name: otel-collector-deployment
     namespace: otel-collector-example
   roleRef:
     kind: ClusterRole
     name: otel-collector
     apiGroup: rbac.authorization.k8s.io

5. OpenTelemetry Collector를 사이드카로 배포합니다.
6. Deployment 오브젝트에서 "sidecar.jaegertracing.io/inject": "true" 주석을 제거하여 애플리케이션에서 삽입된 Jaeger 에이전트를 제거합니다.
7. Deployment 오브젝트의 .spec.template.metadata.annotations 필드에 sidecar.opentelemetry.io/inject: "true" 주석을 추가하여 OpenTelemetry 사이드카 자동 삽입을 활성화합니다.
8. 생성된 서비스 계정을 사용하여 애플리케이션이 배포되면 프로세서가 올바른 정보를 가져와서 추적에 추가할 수 있습니다.

프로세스

1. OpenTelemetry 수집기 배포를 구성합니다.

2. OpenTelemetry 수집기를 배포할 프로젝트를 생성합니다.

   apiVersion: project.openshift.io/v1
   kind: Project
   metadata:
     name: observability

3. OpenTelemetry 수집기 인스턴스를 실행하기 위한 서비스 계정을 생성합니다.

   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: otel-collector-deployment
     namespace: observability

4. 프로세서에 필요한 권한을 설정하는 클러스터 역할을 생성합니다.

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: otel-collector
   rules:
     1
     2
   - apiGroups: ["", "config.openshift.io"]
     resources: ["pods", "namespaces", "infrastructures", "infrastructures/status"]
     verbs: ["get", "watch", "list"]

   1

   k8sattributesprocessor에는 Pod 및 namespaces 리소스에 대한 권한이 필요합니다.

   2

   resourcedetectionprocessor에는 infrastructures 및 infrastructures/status에 대한 권한이 필요합니다.

5. ClusterRoleBinding을 생성하여 서비스 계정에 대한 권한을 설정합니다.

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: otel-collector
   subjects:
   - kind: ServiceAccount
     name: otel-collector-deployment
     namespace: observability
   roleRef:
     kind: ClusterRole
     name: otel-collector
     apiGroup: rbac.authorization.k8s.io

6. OpenTelemetry 수집기 인스턴스를 생성합니다.

   참고

   이 수집기는 추적을 TempoStack 인스턴스로 내보냅니다. Red Hat Tempo Operator를 사용하여 TempoStack 인스턴스를 생성하고 여기에 올바른 끝점을 배치해야 합니다.

   apiVersion: opentelemetry.io/v1alpha1
   kind: OpenTelemetryCollector
   metadata:
     name: otel
     namespace: observability
   spec:
     mode: deployment
     serviceAccount: otel-collector-deployment
     config: |
       receivers:
         jaeger:
           protocols:
             grpc:
             thrift_binary:
             thrift_compact:
             thrift_http:
       processors:
         batch:
         k8sattributes:
         memory_limiter:
           check_interval: 1s
           limit_percentage: 50
           spike_limit_percentage: 30
         resourcedetection:
           detectors: [openshift]
       exporters:
         otlp:
           endpoint: "tempo-example-gateway:8090"
           tls:
             insecure: true
       service:
         pipelines:
           traces:
             receivers: [jaeger]
             processors: [memory_limiter, k8sattributes, resourcedetection, batch]
             exporters: [otlp]

7. 추적 끝점을 OpenTelemetry Operator를 가리킵니다.

8. 애플리케이션에서 직접 추적을 Jaeger로 내보내는 경우 API 끝점을 Jaeger 끝점에서 OpenTelemetry 수집기 끝점으로 변경합니다.

   Golang에서 jaegerexporter 를 사용하여 추적 내보내기 예

   exp, err := jaeger.New(jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(url))) 1

   1

   URL은 OpenTelemetry 수집기 API 끝점을 가리킵니다.

프로세스

1. Operator → 설치된 Operator → OpenTelemetry Operator → OpenTelemetry Instrumentation 또는 OpenTelemetryCollector 로 이동합니다.
2. 관련 인스턴스를 제거하려면 → Delete …​ → Delete 를 선택합니다.
3. 선택 사항: OpenTelemetry Operator의 Red Hat 빌드를 제거합니다.

프로세스

1. 다음 명령을 실행하여 OpenTelemetry 수집기 인스턴스의 이름을 가져옵니다.

   $ oc get deployments -n <project_of_opentelemetry_instance>

2. 다음 명령을 실행하여 OpenTelemetry 수집기 인스턴스를 제거합니다.

   $ oc delete opentelemetrycollectors <opentelemetry_instance_name> -n <project_of_opentelemetry_instance>

3. 선택 사항: OpenTelemetry Operator의 Red Hat 빌드를 제거합니다.