Class Injector
(experimental) Injector is a base class for all SDK injects to mutate the task definition to inject the ADOT init container and configure the application container with the necessary environment variables.
Namespace: Amazon.CDK.AWS.ApplicationSignals.Alpha
Assembly: Amazon.CDK.AWS.ApplicationSignals.Alpha.dll
Syntax (csharp)
public abstract class Injector : DeputyBase
Syntax (vb)
Public MustInherit Class Injector Inherits DeputyBase
Remarks
Stability: Experimental
Synopsis
Constructors
Injector(string, InstrumentationVersion, IEnvironmentExtension[]?) | (experimental) Injector is a base class for all SDK injects to mutate the task definition to inject the ADOT init container and configure the application container with the necessary environment variables. |
Properties
Command | (experimental) The command to run the init container. |
ContainerPath | (experimental) The path to ADOT SDK agent in the init container. |
DEFAULT_ENVS | (experimental) Injector is a base class for all SDK injects to mutate the task definition to inject the ADOT init container and configure the application container with the necessary environment variables. |
InstrumentationVersion | (experimental) Injector is a base class for all SDK injects to mutate the task definition to inject the ADOT init container and configure the application container with the necessary environment variables. |
SharedVolumeName | (experimental) Injector is a base class for all SDK injects to mutate the task definition to inject the ADOT init container and configure the application container with the necessary environment variables. |
Methods
InjectAdditionalEnvironments(IDictionary<string, string>, IDictionary<string, string>) | (experimental) Inject additional environment variables to the application container other than the DEFAULT_ENVS. |
InjectInitContainer(TaskDefinition) | (experimental) Inject ADOT SDK agent init container. |
OverrideAdditionalEnvironments(IDictionary<string, string>, IDictionary<string, string>) | (experimental) Override environment variables in the application container. |
RenderDefaultContainer(TaskDefinition) | (experimental) Render the application container for SDK instrumentation. |
Constructors
Injector(string, InstrumentationVersion, IEnvironmentExtension[]?)
(experimental) Injector is a base class for all SDK injects to mutate the task definition to inject the ADOT init container and configure the application container with the necessary environment variables.
protected Injector(string sharedVolumeName, InstrumentationVersion instrumentationVersion, IEnvironmentExtension[]? overrideEnvironments = null)
Parameters
- sharedVolumeName string
- instrumentationVersion InstrumentationVersion
- overrideEnvironments IEnvironmentExtension[]
Remarks
Stability: Experimental
Properties
Command
(experimental) The command to run the init container.
public abstract string[] Command { get; }
Property Value
string[]
Remarks
Stability: Experimental
ContainerPath
(experimental) The path to ADOT SDK agent in the init container.
public abstract string ContainerPath { get; }
Property Value
Remarks
Stability: Experimental
DEFAULT_ENVS
(experimental) Injector is a base class for all SDK injects to mutate the task definition to inject the ADOT init container and configure the application container with the necessary environment variables.
protected static IEnvironmentExtension[] DEFAULT_ENVS { get; }
Property Value
Remarks
Stability: Experimental
InstrumentationVersion
(experimental) Injector is a base class for all SDK injects to mutate the task definition to inject the ADOT init container and configure the application container with the necessary environment variables.
protected virtual InstrumentationVersion InstrumentationVersion { get; set; }
Property Value
Remarks
Stability: Experimental
SharedVolumeName
(experimental) Injector is a base class for all SDK injects to mutate the task definition to inject the ADOT init container and configure the application container with the necessary environment variables.
protected virtual string SharedVolumeName { get; set; }
Property Value
Remarks
Stability: Experimental
Methods
InjectAdditionalEnvironments(IDictionary<string, string>, IDictionary<string, string>)
(experimental) Inject additional environment variables to the application container other than the DEFAULT_ENVS.
protected abstract void InjectAdditionalEnvironments(IDictionary<string, string> envsToInject, IDictionary<string, string> envsFromTaskDef)
Parameters
- envsToInject IDictionary<string, string>
- envsFromTaskDef IDictionary<string, string>
Remarks
Stability: Experimental
InjectInitContainer(TaskDefinition)
(experimental) Inject ADOT SDK agent init container.
public virtual ContainerDefinition InjectInitContainer(TaskDefinition taskDefinition)
Parameters
- taskDefinition TaskDefinition
The TaskDefinition to render.
Returns
The created ContainerDefinition
Remarks
Stability: Experimental
OverrideAdditionalEnvironments(IDictionary<string, string>, IDictionary<string, string>)
(experimental) Override environment variables in the application container.
protected abstract void OverrideAdditionalEnvironments(IDictionary<string, string> envsToOverride, IDictionary<string, string> envsFromTaskDef)
Parameters
- envsToOverride IDictionary<string, string>
- envsFromTaskDef IDictionary<string, string>
Remarks
Stability: Experimental
RenderDefaultContainer(TaskDefinition)
(experimental) Render the application container for SDK instrumentation.
public virtual void RenderDefaultContainer(TaskDefinition taskDefinition)
Parameters
- taskDefinition TaskDefinition
The TaskDefinition to render.
Remarks
Stability: Experimental