Skip to content

Commit

Permalink
feat(dashboard): add Aoss monitoring dashboard (#686)
Browse files Browse the repository at this point in the history
* chore(aoss): save current work on dashboard

* feat(dashboard): add aoss monitoring dashboard

* chore(test): update tests and add stack id to name

* chore(dahsboard): revert stack id addition
  • Loading branch information
krokoko authored Sep 18, 2024
1 parent 4af4990 commit cbfc18c
Show file tree
Hide file tree
Showing 20 changed files with 1,388 additions and 1 deletion.
9 changes: 9 additions & 0 deletions .gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions .npmignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

69 changes: 69 additions & 0 deletions .projen/tasks.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions apidocs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

## Classes

- [AossCwDashboard](classes/AossCwDashboard.md)
- [BaseClass](classes/BaseClass.md)
- [BedrockCwDashboard](classes/BedrockCwDashboard.md)
- [ContainerImage](classes/ContainerImage.md)
Expand All @@ -41,9 +42,11 @@

## Interfaces

- [AossCwDashboardProps](interfaces/AossCwDashboardProps.md)
- [AsyncInferenceConfig](interfaces/AsyncInferenceConfig.md)
- [BaseClassProps](interfaces/BaseClassProps.md)
- [BedrockCwDashboardProps](interfaces/BedrockCwDashboardProps.md)
- [CollectionMonitoringProps](interfaces/CollectionMonitoringProps.md)
- [ContainerImageConfig](interfaces/ContainerImageConfig.md)
- [ContentGenerationAppSyncLambdaProps](interfaces/ContentGenerationAppSyncLambdaProps.md)
- [CrawlerTarget](interfaces/CrawlerTarget.md)
Expand All @@ -53,6 +56,7 @@
- [IInstanceAliase](interfaces/IInstanceAliase.md)
- [IInstanceValiant](interfaces/IInstanceValiant.md)
- [IJumpStartModelSpec](interfaces/IJumpStartModelSpec.md)
- [IndexMonitoringProps](interfaces/IndexMonitoringProps.md)
- [JumpStartSageMakerEndpointProps](interfaces/JumpStartSageMakerEndpointProps.md)
- [LangchainLayerProps](interfaces/LangchainLayerProps.md)
- [LangchainProps](interfaces/LangchainProps.md)
Expand Down
177 changes: 177 additions & 0 deletions apidocs/classes/AossCwDashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)**Docs**

***

[@cdklabs/generative-ai-cdk-constructs](../README.md) / AossCwDashboard

# Class: AossCwDashboard

The BedrockCwDashboard class.

## Extends

- `Construct`

## Constructors

### new AossCwDashboard()

> **new AossCwDashboard**(`scope`, `id`, `props`): [`AossCwDashboard`](AossCwDashboard.md)
Constructs a new instance of the AossCwDashboard class.

#### Parameters

**scope**: `Construct`

represents the scope for all the resources.

**id**: `string`

this is a a scope-unique id.

**props**: [`AossCwDashboardProps`](../interfaces/AossCwDashboardProps.md)

user provided props for the construct.

#### Returns

[`AossCwDashboard`](AossCwDashboard.md)

#### Since

0.0.0

#### Overrides

`Construct.constructor`

## Properties

### dashboard

> `readonly` **dashboard**: `Dashboard`
Returns the instance of CloudWatch dashboard used by the construct

***

### node

> `readonly` **node**: `Node`
The tree node.

#### Inherited from

`Construct.node`

## Methods

### addCollectionMonitoringByCollection()

> **addCollectionMonitoringByCollection**(`collection`, `props`): `void`
#### Parameters

**collection**: `CfnCollection`

**props**: [`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md)

#### Returns

`void`

***

### addCollectionMonitoringbyAttributes()

> **addCollectionMonitoringbyAttributes**(`collectionName`, `collectionId`, `props`): `void`
#### Parameters

**collectionName**: `string`

**collectionId**: `string`

**props**: [`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md)

#### Returns

`void`

***

### addIndexMonitoringByAtributes()

> **addIndexMonitoringByAtributes**(`collectionName`, `collectionId`, `IndexName`, `IndexId`, `props`): `void`
#### Parameters

**collectionName**: `string`

**collectionId**: `string`

**IndexName**: `string`

**IndexId**: `string`

**props**: [`IndexMonitoringProps`](../interfaces/IndexMonitoringProps.md)

#### Returns

`void`

***

### toString()

> **toString**(): `string`
Returns a string representation of this construct.

#### Returns

`string`

#### Inherited from

`Construct.toString`

***

### isConstruct()

> `static` **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.

Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
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`.

#### Inherited from

`Construct.isConstruct`
40 changes: 40 additions & 0 deletions apidocs/interfaces/AossCwDashboardProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)**Docs**

***

[@cdklabs/generative-ai-cdk-constructs](../README.md) / AossCwDashboardProps

# Interface: AossCwDashboardProps

The properties for the BedrockCwDashboardProps class.

## Properties

### dashboardName?

> `readonly` `optional` **dashboardName**: `string`
Optional A name for the dashboard which will be created.
If existingDashboard is defined, this value will be ignored.
If not provided, the construct will create a new dashboard named 'BedrockMetricsDashboard'

#### Default

```ts
- none
```

***

### existingDashboard?

> `readonly` `optional` **existingDashboard**: `Dashboard`
Optional An existing dashboard where metrics will be added to.
If not provided, the construct will create a new dashboard

#### Default

```ts
- none
```
21 changes: 21 additions & 0 deletions apidocs/interfaces/CollectionMonitoringProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)**Docs**

***

[@cdklabs/generative-ai-cdk-constructs](../README.md) / CollectionMonitoringProps

# Interface: CollectionMonitoringProps

The properties for the CollectionMonitoringProps class.

## Properties

### clientId?

> `readonly` `optional` **clientId**: `string`
***

### period?

> `readonly` `optional` **period**: `Duration`
Loading

0 comments on commit cbfc18c

Please sign in to comment.