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.

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

How do I configure the XRay Exporter when deploying the ADOT Collector to EKS? #2618

Closed
murshed-panorama opened this issue Feb 7, 2024 · 6 comments
Labels

Comments

@murshed-panorama
Copy link

Describe the question
I have the ADOT Collector installed in my EKS cluster as an EKS Add On. When installing this Add On, how can I set configurations for the XRay Exporter?

The documentation mentions setting configuration values in a YAML file, but it does not say how to supply the YAML file when installing the Add On.

What did you expect to see?
I expected the documentation to mention how to configure the XRay exporter when installing the EKS Add On.

Environment

The adot Add On is installed with the following commands

# Required but not well documented
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.12.7/cert-manager.yaml

aws eks create-addon \
    --cluster-name my-cluster \
    --addon-name adot \
    --configuration-values file://configuration-values.json \
    --resolve-conflicts=OVERWRITE

The contents of configuration-values.json:

{
  "collector": {
    "otlpIngest": {
      "pipelines": {
        "traces": {
          "xray": {
            "enabled": true
          }
        }
      },
      "serviceAccount": {
        "annotations": {
          "eks.amazonaws.com/role-arn": "arn:aws:iam::123456789012:role/role-with-xray-write-access"
        }
      }
    }
  }
}

Additional context

I would like to specifically enable the index_all_attributes or index_attributes configuration field for XRay because all my OpenTelemetry attributes are translated to metadata and are not searchable unless they are annotations.

I want to automate the installation process and don't want to edit configuration files with kubectl manually after the installation.

@murshed-panorama
Copy link
Author

murshed-panorama commented Feb 8, 2024

@jatinmehrotra Thank you for replying. Yes I'm aware the configuration YAML file is in the documentation, as I've already linked to it in my original post above.

My issue is that there are no instructions on how to apply this configuration when installing the adot EKS addon. Can it be packaged with the adot add on?

Am I expected to manually apply this configuration file with kubectl? Is there a Helm package available?

@bryan-aguilar
Copy link
Contributor

You can provide configurations to the collector by using config map providers at startup. https://aws-otel.github.io/docs/components/confmap-providers

@jatinmehrotra
Copy link

jatinmehrotra commented Feb 17, 2024

@murshed-panorama

IMO there is no helm package.

Am I expected to manually apply this configuration file with kubectl?

Yes. But if you are using terraform this can be automated with kubectl_manifest resource.

My issue is that there are no instructions on how to apply this configuration when installing the adot EKS addon. Can it be packaged with the adot add on?

I think you are looking for this particular information that will help you to deploy the collector during add-on installation. But I should also tell you that as per docs you will lose the ability to add the iam_role(for assume role) option in case you want to send traces to the central monitoring account. Perhaps that is why I have chose to deploy my collector manually using yaml configuration.

https://aws-otel.github.io/docs/getting-started/adot-eks-add-on/add-on-configuration-collector-deployment
https://aws-otel.github.io/docs/getting-started/adot-eks-add-on/config-otlp-ingest

Copy link
Contributor

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 30 days.

@github-actions github-actions bot added the stale label Apr 21, 2024
Copy link
Contributor

This issue was closed because it has been marked as stale for 30 days with no activity.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants