From 0fb3f6d0342567396887355c18220f44a0be631e Mon Sep 17 00:00:00 2001 From: plumdog Date: Thu, 21 Dec 2023 15:58:41 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20isotoma/?= =?UTF-8?q?datadog-ecs-cdk@a96a11552ad2a4dd80c42c115a79d73de47e1e55=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/ec2.DatadogEcsDaemonService.html | 10 +++++----- .../fargate.addDatadogToFargateTask.html | 4 ++-- index.html | 4 ++-- .../ec2.DatadogEcsDaemonServiceProps.html | 20 +++++++++---------- interfaces/ec2.DatadogEcsLogsProps.html | 8 ++++---- .../fargate.AddDatadogToFargateTaskProps.html | 8 ++++---- .../fargate.DatadogFargateAgentProps.html | 14 ++++++------- ...adogFargateApmApplicationEnvVarsProps.html | 10 +++++----- .../fargate.DatadogFargateApmProps.html | 8 ++++---- ...te.DatadogFargateFirelensLoggingProps.html | 18 ++++++++--------- ...gFargateStatsdApplicationEnvVarsProps.html | 8 ++++---- .../fargate.DatadogFargateStatsdProps.html | 8 ++++---- modules/ec2.html | 4 ++-- modules/fargate.html | 4 ++-- 14 files changed, 64 insertions(+), 64 deletions(-) diff --git a/classes/ec2.DatadogEcsDaemonService.html b/classes/ec2.DatadogEcsDaemonService.html index 2309b40..42d709e 100644 --- a/classes/ec2.DatadogEcsDaemonService.html +++ b/classes/ec2.DatadogEcsDaemonService.html @@ -1,15 +1,15 @@ -DatadogEcsDaemonService | datadog-ecs-cdk - v1.3.1

Class DatadogEcsDaemonService

Deploys the Datadog agent as a daemon service to an ECS cluster.

+DatadogEcsDaemonService | datadog-ecs-cdk - v1.3.2

Class DatadogEcsDaemonService

Deploys the Datadog agent as a daemon service to an ECS cluster.

Remarks

This construct is intended to be used with an ECS cluster makes use of EC2 instances. It is not intended to be used with an ECS cluster that only runs Fargate tasks. See addDatadogToFargateTask for retrieving logs and metrics from Fargate tasks.

-

Hierarchy

  • Construct
    • DatadogEcsDaemonService

Constructors

constructor +

Hierarchy

  • Construct
    • DatadogEcsDaemonService

Constructors

constructor

Properties

node service

Methods

toString isConstruct -

Constructors

constructor

Properties

Readonly node

node: Node

The tree node.

-

Readonly service

service: Ec2Service

Methods

toString

  • toString(): string

  • Returns a string representation of this construct.

    +

Constructors

constructor

Properties

Readonly node

node: Node

The tree node.

+

Readonly service

service: Ec2Service

Methods

toString

  • toString(): string

  • Returns a string representation of this construct.

    Returns string

Static isConstruct

  • isConstruct(x): x is Construct

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    @@ -25,4 +25,4 @@ this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/fargate.addDatadogToFargateTask.html b/functions/fargate.addDatadogToFargateTask.html index e26c0b0..0f38f85 100644 --- a/functions/fargate.addDatadogToFargateTask.html +++ b/functions/fargate.addDatadogToFargateTask.html @@ -1,6 +1,6 @@ -addDatadogToFargateTask | datadog-ecs-cdk - v1.3.1

Function addDatadogToFargateTask

  • addDatadogToFargateTask(task, props): void

  • Adds the Datadog agent and firelens logging configuration to a Fargate task

    +addDatadogToFargateTask | datadog-ecs-cdk - v1.3.2

    Function addDatadogToFargateTask

    • addDatadogToFargateTask(task, props): void

    • Adds the Datadog agent and firelens logging configuration to a Fargate task

      Parameters

      Returns void

      Remarks

      This is intended to be used with a Fargate task. It is not intended to be used with non-Fargate tasks. See EcsDatadogDaemonService for deploying the Datadog agent to an ECS cluster that makes use of EC2 instances.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index a63944c..99f9bc8 100644 --- a/index.html +++ b/index.html @@ -1,8 +1,8 @@ -datadog-ecs-cdk - v1.3.1

datadog-ecs-cdk - v1.3.1

datadog-ecs-cdk

Docs: https://isotoma.github.io/datadog-ecs-cdk/

+datadog-ecs-cdk - v1.3.2

datadog-ecs-cdk - v1.3.2

datadog-ecs-cdk

Docs: https://isotoma.github.io/datadog-ecs-cdk/

NPM: https://www.npmjs.com/package/datadog-ecs-cdk

Source: https://github.com/isotoma/datadog-ecs-cdk

EC2 example

import { EcsDatadogDaemonService } from 'datadog-ecs-cdk';

// ...

new EcsDatadogDaemonService(this, 'EcsDatadog', {
    ecsCluster: myCluster,
    datadogApiKeySecret: ecs.Secret.fromSecretsManager(mySecret),
});

Fargate example

import { addDatadogToFargateTask } from 'datadog-ecs-cdk';

// ...

const myTaskDef = ...

addDatadogToFargateTask(myTaskDef, {
    datadogApiKeySecret: ecs.Secret.fromSecretsManager(mySecret),
    agent: {
        enabled: true,
        statsd: {
            enabled: true,
        },
    },
    fireLensLogging: {
        enabled: true,
        service: 'myservice',
        source: 'myservice',
    },
});
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ec2.DatadogEcsDaemonServiceProps.html b/interfaces/ec2.DatadogEcsDaemonServiceProps.html index 4308828..6fbd732 100644 --- a/interfaces/ec2.DatadogEcsDaemonServiceProps.html +++ b/interfaces/ec2.DatadogEcsDaemonServiceProps.html @@ -1,4 +1,4 @@ -DatadogEcsDaemonServiceProps | datadog-ecs-cdk - v1.3.1

Interface DatadogEcsDaemonServiceProps

interface DatadogEcsDaemonServiceProps {
    cpu?: number;
    datadogApiKeySecret: ISecret | Secret;
    datadogSite?: string;
    disableHealthcheck?: boolean;
    ecsCluster: Cluster;
    image?: ContainerImage;
    imageTag?: string;
    logToCloudWatch?: boolean;
    logs?: DatadogEcsLogsProps;
    memoryLimitMiB?: number;
}

Properties

cpu? +DatadogEcsDaemonServiceProps | datadog-ecs-cdk - v1.3.2

Interface DatadogEcsDaemonServiceProps

interface DatadogEcsDaemonServiceProps {
    cpu?: number;
    datadogApiKeySecret: ISecret | Secret;
    datadogSite?: string;
    disableHealthcheck?: boolean;
    ecsCluster: Cluster;
    image?: ContainerImage;
    imageTag?: string;
    logToCloudWatch?: boolean;
    logs?: DatadogEcsLogsProps;
    memoryLimitMiB?: number;
}

Properties

cpu? datadogApiKeySecret datadogSite? disableHealthcheck? @@ -11,30 +11,30 @@

Properties

Optional Readonly cpu

cpu?: number

The number of CPU units to reserve for the container

Default

100
-

Readonly datadogApiKeySecret

datadogApiKeySecret: ISecret | Secret

The secret containing the Datadog API key

+

Readonly datadogApiKeySecret

datadogApiKeySecret: ISecret | Secret

The secret containing the Datadog API key

Remarks

Pass an ecs.Secret for full control over the source of this. Can pass an ISecret for backwards compatibility, though this must be a secret storing a single value, not key-value pairs.

-

Optional Readonly datadogSite

datadogSite?: string

The Datadog site to send data to

+

Optional Readonly datadogSite

datadogSite?: string

The Datadog site to send data to

Remarks

Defaults to datadoghq.com See information about other datadog site parameters at https://docs.datadoghq.com/getting_started/site/#access-the-datadog-site

-

Optional Readonly disableHealthcheck

disableHealthcheck?: boolean

Whether to disable the agent's healthcheck

+

Optional Readonly disableHealthcheck

disableHealthcheck?: boolean

Whether to disable the agent's healthcheck

Default

false
-

Readonly ecsCluster

ecsCluster: Cluster

The ECS cluster to deploy the Datadog agent to

-

Optional Readonly image

image?: ContainerImage

The image to use for the container

+

Readonly ecsCluster

ecsCluster: Cluster

The ECS cluster to deploy the Datadog agent to

+

Optional Readonly image

image?: ContainerImage

The image to use for the container

Default

ecs.ContainerImage.fromRegistry('public.ecr.aws/datadog/agent:latest')
-

Optional Readonly imageTag

imageTag?: string

The image tag to use for the container

+

Optional Readonly imageTag

imageTag?: string

The image tag to use for the container

Remarks

This is ignored if image is specified

Default

'latest'
-

Optional Readonly logToCloudWatch

logToCloudWatch?: boolean

Whether the agent's logs should be sent to CloudWatch

+

Optional Readonly logToCloudWatch

logToCloudWatch?: boolean

Whether the agent's logs should be sent to CloudWatch

Default

false
-

Optional Readonly logs

logs?: DatadogEcsLogsProps

Optional Readonly memoryLimitMiB

memoryLimitMiB?: number

The amount (in MiB) of memory to present to the container

+

Optional Readonly logs

logs?: DatadogEcsLogsProps

Optional Readonly memoryLimitMiB

memoryLimitMiB?: number

The amount (in MiB) of memory to present to the container

Default

512
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ec2.DatadogEcsLogsProps.html b/interfaces/ec2.DatadogEcsLogsProps.html index 0a43180..0fc2f5c 100644 --- a/interfaces/ec2.DatadogEcsLogsProps.html +++ b/interfaces/ec2.DatadogEcsLogsProps.html @@ -1,13 +1,13 @@ -DatadogEcsLogsProps | datadog-ecs-cdk - v1.3.1

Interface DatadogEcsLogsProps

interface DatadogEcsLogsProps {
    collectFromAgentContainer?: boolean;
    collectFromAllContainers?: boolean;
    enabled?: boolean;
}

Properties

collectFromAgentContainer? +DatadogEcsLogsProps | datadog-ecs-cdk - v1.3.2

Interface DatadogEcsLogsProps

interface DatadogEcsLogsProps {
    collectFromAgentContainer?: boolean;
    collectFromAllContainers?: boolean;
    enabled?: boolean;
}

Properties

collectFromAgentContainer? collectFromAllContainers? enabled?

Properties

Optional Readonly collectFromAgentContainer

collectFromAgentContainer?: boolean

Collect logs from the agent container itself

Default

false
-

Optional Readonly collectFromAllContainers

collectFromAllContainers?: boolean

Whether to collect from all containers

+

Optional Readonly collectFromAllContainers

collectFromAllContainers?: boolean

Whether to collect from all containers

Default

true
-

Optional Readonly enabled

enabled?: boolean

Whether logging should be enabled

+

Optional Readonly enabled

enabled?: boolean

Whether logging should be enabled

Default

false
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/fargate.AddDatadogToFargateTaskProps.html b/interfaces/fargate.AddDatadogToFargateTaskProps.html index 0405f5f..73dcdc3 100644 --- a/interfaces/fargate.AddDatadogToFargateTaskProps.html +++ b/interfaces/fargate.AddDatadogToFargateTaskProps.html @@ -1,18 +1,18 @@ -AddDatadogToFargateTaskProps | datadog-ecs-cdk - v1.3.1

Interface AddDatadogToFargateTaskProps

interface AddDatadogToFargateTaskProps {
    agent?: DatadogFargateAgentProps;
    datadogApiKeySecret: Secret;
    datadogSite?: string;
    fireLensLogging?: DatadogFargateFirelensLoggingProps;
}

Properties

agent? +AddDatadogToFargateTaskProps | datadog-ecs-cdk - v1.3.2

Interface AddDatadogToFargateTaskProps

interface AddDatadogToFargateTaskProps {
    agent?: DatadogFargateAgentProps;
    datadogApiKeySecret: Secret;
    datadogSite?: string;
    fireLensLogging?: DatadogFargateFirelensLoggingProps;
}

Properties

agent? datadogApiKeySecret datadogSite? fireLensLogging? -

Properties

Optional agent

agent?: DatadogFargateAgentProps

datadogApiKeySecret

datadogApiKeySecret: Secret

The secret containing the Datadog API key

+

Properties

Optional agent

agent?: DatadogFargateAgentProps

datadogApiKeySecret

datadogApiKeySecret: Secret

The secret containing the Datadog API key

Remarks

It is important that the value specified by this secret doesn't have a newline at the end. Otherwise, the firelens logging configuration will fail to send logs to Datadog. This is an easy mistake to introduce when the source for the secret is a secretsmanager Secret containing a single value, rather than key-value pairs.

-

Optional datadogSite

datadogSite?: string

The Datadog site to send data to

+

Optional datadogSite

datadogSite?: string

The Datadog site to send data to

Remarks

Defaults to datadoghq.com See information about other datadog site parameters at https://docs.datadoghq.com/getting_started/site/#access-the-datadog-site

Default

datadoghq.com
-

Optional fireLensLogging

fireLensLogging?: DatadogFargateFirelensLoggingProps

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional fireLensLogging

fireLensLogging?: DatadogFargateFirelensLoggingProps

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/fargate.DatadogFargateAgentProps.html b/interfaces/fargate.DatadogFargateAgentProps.html index 988f3d2..88a8294 100644 --- a/interfaces/fargate.DatadogFargateAgentProps.html +++ b/interfaces/fargate.DatadogFargateAgentProps.html @@ -1,4 +1,4 @@ -DatadogFargateAgentProps | datadog-ecs-cdk - v1.3.1

Interface DatadogFargateAgentProps

interface DatadogFargateAgentProps {
    apm?: DatadogFargateApmProps;
    cpu?: number;
    enabled?: boolean;
    image?: ContainerImage;
    imageTag?: string;
    logToCloudWatch?: boolean;
    memoryLimitMiB?: number;
    statsd?: DatadogFargateStatsdProps;
}

Properties

apm? +DatadogFargateAgentProps | datadog-ecs-cdk - v1.3.2

Interface DatadogFargateAgentProps

interface DatadogFargateAgentProps {
    apm?: DatadogFargateApmProps;
    cpu?: number;
    enabled?: boolean;
    image?: ContainerImage;
    imageTag?: string;
    logToCloudWatch?: boolean;
    memoryLimitMiB?: number;
    statsd?: DatadogFargateStatsdProps;
}

Properties

apm? cpu? enabled? image? @@ -6,29 +6,29 @@ logToCloudWatch? memoryLimitMiB? statsd? -

Properties

Optional apm

apm?: DatadogFargateApmProps

Optional cpu

cpu?: number

Optional enabled

enabled?: boolean

Whether the Datadog agent should be enabled

+

Properties

Optional apm

apm?: DatadogFargateApmProps

Optional cpu

cpu?: number

Optional enabled

enabled?: boolean

Whether the Datadog agent should be enabled

Remarks

If this is not enabled, the agent will not be deployed to the task. This is useful if you only want to use the firelens logging configuration.

Default

false
-

Optional image

image?: ContainerImage

The image to use for the Datadog agent

+

Optional image

image?: ContainerImage

The image to use for the Datadog agent

Remarks

This is useful if you want to use a custom image for the Datadog agent.

Default

ecs.ContainerImage.fromRegistry('public.ecr.aws/datadog/agent:latest')
-

Optional imageTag

imageTag?: string

The tag to use for the Datadog agent image

+

Optional imageTag

imageTag?: string

The tag to use for the Datadog agent image

Remarks

This is useful if you want to use a custom image for the Datadog agent. This will be ignored if setting image.

Default

latest
-

Optional logToCloudWatch

logToCloudWatch?: boolean

Whether the Datadog agent should log to CloudWatch.

+

Optional logToCloudWatch

logToCloudWatch?: boolean

Whether the Datadog agent should log to CloudWatch.

Remarks

If this is enabled, the Datadog agent will log its own output to CloudWatch. This is useful if you want to see the logs to debug the Datadog agent.

Default

false
-

Optional memoryLimitMiB

memoryLimitMiB?: number

The memory limit for the Datadog agent container

+

Optional memoryLimitMiB

memoryLimitMiB?: number

The memory limit for the Datadog agent container

Default

256
-

Optional statsd

statsd?: DatadogFargateStatsdProps

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional statsd

statsd?: DatadogFargateStatsdProps

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/fargate.DatadogFargateApmApplicationEnvVarsProps.html b/interfaces/fargate.DatadogFargateApmApplicationEnvVarsProps.html index f0903a1..ae6edbd 100644 --- a/interfaces/fargate.DatadogFargateApmApplicationEnvVarsProps.html +++ b/interfaces/fargate.DatadogFargateApmApplicationEnvVarsProps.html @@ -1,4 +1,4 @@ -DatadogFargateApmApplicationEnvVarsProps | datadog-ecs-cdk - v1.3.1

Interface DatadogFargateApmApplicationEnvVarsProps

interface DatadogFargateApmApplicationEnvVarsProps {
    apmHostEnvVarName?: string;
    apmPortEnvVarName?: string;
    apmTraceEnabledEnvVarName?: string;
    doNotSet?: boolean;
}

Properties

apmHostEnvVarName? +DatadogFargateApmApplicationEnvVarsProps | datadog-ecs-cdk - v1.3.2

Interface DatadogFargateApmApplicationEnvVarsProps

interface DatadogFargateApmApplicationEnvVarsProps {
    apmHostEnvVarName?: string;
    apmPortEnvVarName?: string;
    apmTraceEnabledEnvVarName?: string;
    doNotSet?: boolean;
}

Properties

apmHostEnvVarName? apmPortEnvVarName? apmTraceEnabledEnvVarName? doNotSet? @@ -6,19 +6,19 @@ host of the Datadog agent

Default

DD_AGENT_HOST
-

Optional apmPortEnvVarName

apmPortEnvVarName?: string

The name of the environment variable to set to the +

Optional apmPortEnvVarName

apmPortEnvVarName?: string

The name of the environment variable to set to the port of the Datadog agent

Default

DD_TRACE_AGENT_PORT
-

Optional apmTraceEnabledEnvVarName

apmTraceEnabledEnvVarName?: string

The name of the environment variable to set to enable +

Optional apmTraceEnabledEnvVarName

apmTraceEnabledEnvVarName?: string

The name of the environment variable to set to enable tracing in the application

Default

DD_TRACE_ENABLED
-

Optional doNotSet

doNotSet?: boolean

Whether to skip setting the environment variables +

Optional doNotSet

doNotSet?: boolean

Whether to skip setting the environment variables in the other containers in the task.

Remarks

By default, the other containers will have the default environment variables set to allow sending traces to the APM.

Default

false
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/fargate.DatadogFargateApmProps.html b/interfaces/fargate.DatadogFargateApmProps.html index 1c433cd..1151919 100644 --- a/interfaces/fargate.DatadogFargateApmProps.html +++ b/interfaces/fargate.DatadogFargateApmProps.html @@ -1,10 +1,10 @@ -DatadogFargateApmProps | datadog-ecs-cdk - v1.3.1

Interface DatadogFargateApmProps

interface DatadogFargateApmProps {
    applicationEnvVars?: DatadogFargateApmApplicationEnvVarsProps;
    enabled?: boolean;
    port?: number;
}

Properties

applicationEnvVars? +DatadogFargateApmProps | datadog-ecs-cdk - v1.3.2

Interface DatadogFargateApmProps

interface DatadogFargateApmProps {
    applicationEnvVars?: DatadogFargateApmApplicationEnvVarsProps;
    enabled?: boolean;
    port?: number;
}

Properties

applicationEnvVars? enabled? port? -

Properties

Optional applicationEnvVars

applicationEnvVars?: DatadogFargateApmApplicationEnvVarsProps

Optional enabled

enabled?: boolean

Whether the Datadog APM should be enabled within the agent

+

Properties

Optional applicationEnvVars

applicationEnvVars?: DatadogFargateApmApplicationEnvVarsProps

Optional enabled

enabled?: boolean

Whether the Datadog APM should be enabled within the agent

Default

false
-

Optional port

port?: number

Port on which the APM will listen for traces

+

Optional port

port?: number

Port on which the APM will listen for traces

Default

8126
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/fargate.DatadogFargateFirelensLoggingProps.html b/interfaces/fargate.DatadogFargateFirelensLoggingProps.html index 17e6ae6..43d4578 100644 --- a/interfaces/fargate.DatadogFargateFirelensLoggingProps.html +++ b/interfaces/fargate.DatadogFargateFirelensLoggingProps.html @@ -1,4 +1,4 @@ -DatadogFargateFirelensLoggingProps | datadog-ecs-cdk - v1.3.1

Interface DatadogFargateFirelensLoggingProps

interface DatadogFargateFirelensLoggingProps {
    cpu?: number;
    enabled?: boolean;
    image?: ContainerImage;
    imageTag?: string;
    memoryLimitMiB?: number;
    service?: string;
    source?: string;
    tags?: Record<string, string>;
}

Properties

cpu? +DatadogFargateFirelensLoggingProps | datadog-ecs-cdk - v1.3.2

Interface DatadogFargateFirelensLoggingProps

interface DatadogFargateFirelensLoggingProps {
    cpu?: number;
    enabled?: boolean;
    image?: ContainerImage;
    imageTag?: string;
    memoryLimitMiB?: number;
    service?: string;
    source?: string;
    tags?: Record<string, string>;
}

Properties

cpu? enabled? image? imageTag? @@ -9,29 +9,29 @@

Properties

Optional cpu

cpu?: number

The CPU units to reserve for the firelens logging container

Remarks

By default, this will be unset and the firelens logging container will be able to use all available CPU units.

-

Optional enabled

enabled?: boolean

Whether the firelens logging configuration should be enabled

+

Optional enabled

enabled?: boolean

Whether the firelens logging configuration should be enabled

Remarks

If this is not enabled, the firelens logging configuration will not be deployed to the task. This is useful if you only want to use the Datadog agent.

Default

false
-

Optional image

image?: ContainerImage

The image to use for the firelens logging container

+

Optional image

image?: ContainerImage

The image to use for the firelens logging container

Default

ecs.ContainerImage.fromRegistry('public.ecr.aws/aws-observability/aws-for-fluent-bit:latest')
-

Optional imageTag

imageTag?: string

The tag to use for the firelens logging container image

+

Optional imageTag

imageTag?: string

The tag to use for the firelens logging container image

Remarks

This is ignored if setting image.

Default

latest
-

Optional memoryLimitMiB

memoryLimitMiB?: number

The memory limit for the firelens logging container

+

Optional memoryLimitMiB

memoryLimitMiB?: number

The memory limit for the firelens logging container

Default

256
-

Optional service

service?: string

The service name to include in the logs sent to Datadog

+

Optional service

service?: string

The service name to include in the logs sent to Datadog

Remarks

By default, this will be unset and the logs will be sent without a service tag.

-

Optional source

source?: string

The source name to include in the logs sent to Datadog

+

Optional source

source?: string

The source name to include in the logs sent to Datadog

Remarks

By default, this will be unset and the logs will be sent without a source tag.

-

Optional tags

tags?: Record<string, string>

Any additional tags to include in the logs sent to Datadog

+

Optional tags

tags?: Record<string, string>

Any additional tags to include in the logs sent to Datadog

Remarks

By default, this will be unset and the logs will be sent without any additional tags.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/fargate.DatadogFargateStatsdApplicationEnvVarsProps.html b/interfaces/fargate.DatadogFargateStatsdApplicationEnvVarsProps.html index ebd9b82..c1ae74e 100644 --- a/interfaces/fargate.DatadogFargateStatsdApplicationEnvVarsProps.html +++ b/interfaces/fargate.DatadogFargateStatsdApplicationEnvVarsProps.html @@ -1,4 +1,4 @@ -DatadogFargateStatsdApplicationEnvVarsProps | datadog-ecs-cdk - v1.3.1

Interface DatadogFargateStatsdApplicationEnvVarsProps

interface DatadogFargateStatsdApplicationEnvVarsProps {
    doNotSet?: boolean;
    statsdHostEnvVarName?: string;
    statsdPortEnvVarName?: string;
}

Properties

doNotSet? +DatadogFargateStatsdApplicationEnvVarsProps | datadog-ecs-cdk - v1.3.2

Interface DatadogFargateStatsdApplicationEnvVarsProps

interface DatadogFargateStatsdApplicationEnvVarsProps {
    doNotSet?: boolean;
    statsdHostEnvVarName?: string;
    statsdPortEnvVarName?: string;
}

Properties

doNotSet? statsdHostEnvVarName? statsdPortEnvVarName?

Properties

Optional doNotSet

doNotSet?: boolean

Whether to skip setting the environment variables @@ -8,12 +8,12 @@ to the StatsD server.

Default

false
-

Optional statsdHostEnvVarName

statsdHostEnvVarName?: string

The name of the environment variable to set to the +

Optional statsdHostEnvVarName

statsdHostEnvVarName?: string

The name of the environment variable to set to the host of the Datadog agent

Default

STATSD_HOST
-

Optional statsdPortEnvVarName

statsdPortEnvVarName?: string

The name of the environment variable to set to the +

Optional statsdPortEnvVarName

statsdPortEnvVarName?: string

The name of the environment variable to set to the port of the Datadog agent

Default

STATSD_PORT
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/fargate.DatadogFargateStatsdProps.html b/interfaces/fargate.DatadogFargateStatsdProps.html index 903f9a0..ca450f6 100644 --- a/interfaces/fargate.DatadogFargateStatsdProps.html +++ b/interfaces/fargate.DatadogFargateStatsdProps.html @@ -1,10 +1,10 @@ -DatadogFargateStatsdProps | datadog-ecs-cdk - v1.3.1

Interface DatadogFargateStatsdProps

interface DatadogFargateStatsdProps {
    applicationEnvVars?: DatadogFargateStatsdApplicationEnvVarsProps;
    enabled?: boolean;
    port?: number;
}

Properties

applicationEnvVars? +DatadogFargateStatsdProps | datadog-ecs-cdk - v1.3.2

Interface DatadogFargateStatsdProps

interface DatadogFargateStatsdProps {
    applicationEnvVars?: DatadogFargateStatsdApplicationEnvVarsProps;
    enabled?: boolean;
    port?: number;
}

Properties

applicationEnvVars? enabled? port? -

Properties

Optional applicationEnvVars

applicationEnvVars?: DatadogFargateStatsdApplicationEnvVarsProps

Optional enabled

enabled?: boolean

Whether the Datadog StatsD server should be enabled within the agent

+

Properties

Optional applicationEnvVars

applicationEnvVars?: DatadogFargateStatsdApplicationEnvVarsProps

Optional enabled

enabled?: boolean

Whether the Datadog StatsD server should be enabled within the agent

Default

false
-

Optional port

port?: number

Port on which the StatsD server will listen for metrics

+

Optional port

port?: number

Port on which the StatsD server will listen for metrics

Default

8125
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/modules/ec2.html b/modules/ec2.html index 50f8f04..ca720bf 100644 --- a/modules/ec2.html +++ b/modules/ec2.html @@ -1,4 +1,4 @@ -ec2 | datadog-ecs-cdk - v1.3.1

Module ec2

Index

Classes

DatadogEcsDaemonService +ec2 | datadog-ecs-cdk - v1.3.2

Module ec2

Index

Classes

DatadogEcsDaemonService

Interfaces

DatadogEcsDaemonServiceProps DatadogEcsLogsProps -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/modules/fargate.html b/modules/fargate.html index 65d3b2d..55cec6a 100644 --- a/modules/fargate.html +++ b/modules/fargate.html @@ -1,4 +1,4 @@ -fargate | datadog-ecs-cdk - v1.3.1

Module fargate

Index

Interfaces

AddDatadogToFargateTaskProps +fargate | datadog-ecs-cdk - v1.3.2

Module fargate

Index

Interfaces

AddDatadogToFargateTaskProps DatadogFargateAgentProps DatadogFargateApmApplicationEnvVarsProps DatadogFargateApmProps @@ -6,4 +6,4 @@ DatadogFargateStatsdApplicationEnvVarsProps DatadogFargateStatsdProps

Functions

addDatadogToFargateTask -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file