digma-ai / digma-ui

MIT License
3 stars 1 forks source link

add to run config documentation changes #844

Closed shaykeren closed 1 month ago

shaykeren commented 1 month ago

related to https://github.com/digma-ai/digma-intellij-plugin/issues/2116 please merge the changes into plugin branch: use-env-name-in-run-config

Add RunConfig Changes

if Centralize = false.  (LOCAL DEPLOYMENT)
    if isMicrometerProject:
        MANAGEMENT_OPENTELEMETRY_RESOURCE-ATTRIBUTES_digma_environment=[ENVIRONMENT_NAME]
    else:
        OTEL_RESOURCE_ATTRIBUTES=digma.environment=[ENVIRONMENT_NAME]

if Centralize = true.  (CENTRALIZE DEPLOYMENT)
          if isMicrometerProject:
               if the environment type is public:
                   MANAGEMENT_OPENTELEMETRY_RESOURCE-ATTRIBUTES_digma_environment=[ENVIRONMENT_NAME]
                   MANAGEMENT_OPENTELEMETRY_RESOURCE-ATTRIBUTES_digma_environment_type=[ENVIRONMENT_TYPE]
               else://private
                    MANAGEMENT_OPENTELEMETRY_RESOURCE-ATTRIBUTES_digma_environment=[ENVIRONMENT_NAME]
                    MANAGEMENT_OPENTELEMETRY_RESOURCE-ATTRIBUTES_digma_environment_type=[ENVIRONMENT_TYPE]
                    MANAGEMENT_OPENTELEMETRY_RESOURCE-ATTRIBUTES_digma_user_id=[USER_ID]
          else:
               if the environment type is public:
                       OTEL_RESOURCE_ATTRIBUTES=digma.environment=[ENVIRONMENT_NAME],digma.environment.type=[ENVIRONMENT_TYPE]
               else: //private
                     OTEL_RESOURCE_ATTRIBUTES=digma.environment=[ENVIRONMENT_NAME],digma.environment.type=[ENVIRONMENT_TYPE],digma.user.id=[USERID]

How to setup changes:

Centralize:

image

Local

image

Troubleshoot changes: via terminal:

replace the following line: export OTEL_RESOURCE_ATTRIBUTES=digma.environment.id={--ENTER YOUR ENVIRONMENT ID HERE--} with the new one below:

If not Centralized: export OTEL_RESOURCE_ATTRIBUTES=digma.environment={--ENTER YOUR ENVIRONMENT NAME HERE--}

If Centralized:

#    2 Options for Local(Private) environment  
#1. specifying environment name, type and user_id
# export OTEL_RESOURCE_ATTRIBUTES=digma.environment={--ENTER YOUR ENVIRONMENT NAME HERE--},digma.environment.type=Private, digma.user.id={---ENTER YOUR USER ID HERE-}
#2. use environment id
# export OTEL_RESOURCE_ATTRIBUTES=digma.environment.id={--ENTER YOUR ENVIRONMENT Id HERE--}            
#    2 Options For CI/Prod (Public) environment
#1. specifying environment name, type
# export OTEL_RESOURCE_ATTRIBUTES=digma.environment={--ENTER YOUR ENVIRONMENT NAME HERE--},digma.environment.type=Private
#2. use environment id
# export OTEL_RESOURCE_ATTRIBUTES=digma.environment.id={--ENTER YOUR ENVIRONMENT Id HERE--}    

If Not Centralized:

export OTEL_RESOURCE_ATTRIBUTES=digma.environment={--ENTER YOUR ENVIRONMENT NAME HERE--}

TBD Docker

TBD Digma documentation:https://docs.digma.ai/digma-developer-guide/instrumentation/spring-spring-boot-dropwizard-and-default/instrumenting-your-code-in-ci-staging-or-the-terminal

TBD what if the project isMicrometer ? different variables!

shaykeren commented 1 month ago

duplicate #850 https://github.com/digma-ai/digma-ui/issues/850