# API Reference
## Constructs
### CrashyTaskMetrics
Provide metrics for crashy tasks run by an ECS Service.
#### Initializers
```typescript
import { CrashyTaskMetrics } from '@wheatstalk/cdk-crashy-task-metrics'
new CrashyTaskMetrics(scope: Construct, id: string, props: CrashyTaskMetricsProps)
```
##### `scope`Required
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`@wheatstalk/cdk-crashy-task-metrics.CrashyTaskMetricsProps`](#@wheatstalk/cdk-crashy-task-metrics.CrashyTaskMetricsProps)
---
#### Methods
##### `metricTaskCrashes`
```typescript
public metricTaskCrashes(props?: MetricOptions)
```
###### `props`Optional
- *Type:* [`@aws-cdk/aws-cloudwatch.MetricOptions`](#@aws-cdk/aws-cloudwatch.MetricOptions)
---
## Structs
### CrashyTaskMetricsProps
Props for `CrashyTaskMetrics`.
#### Initializer
```typescript
import { CrashyTaskMetricsProps } from '@wheatstalk/cdk-crashy-task-metrics'
const crashyTaskMetricsProps: CrashyTaskMetricsProps = { ... }
```
##### `service`Required
```typescript
public readonly service: FargateService | Ec2Service;
```
- *Type:* [`@aws-cdk/aws-ecs.FargateService`](#@aws-cdk/aws-ecs.FargateService) | [`@aws-cdk/aws-ecs.Ec2Service`](#@aws-cdk/aws-ecs.Ec2Service)
ECS service to report metrics on.
---
##### `metricName`Optional
```typescript
public readonly metricName: string;
```
- *Type:* `string`
- *Default:* 'TaskCrashes'
Metric name.
---
##### `metricNamespace`Optional
```typescript
public readonly metricNamespace: string;
```
- *Type:* `string`
- *Default:* 'cdk-crashy-task-metrics'
Metric namespace.
---