Skip to content

Commit

Permalink
chore(docs): document how to override segment widgets
Browse files Browse the repository at this point in the history
  • Loading branch information
echeung-amzn committed Nov 10, 2023
1 parent 3c1f088 commit aeb91fb
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,13 @@ This is a general procedure on how to do it:

Both of these monitoring base classes are dashboard segments, so you can add them to your monitoring by calling `.addSegment()` on the `MonitoringFacade`.

### Modifying or omitting widgets from default dashboard segments

While the dashboard widgets defined in the library are meant to cover most use cases, they might not be what you're looking for.

To modify the widgets, extend the appropriate `Monitoring` class (e.g., `LambdaFunctionMonitoring` for `monitorLambdaFunction`) and override the relevant methods (e.g., `widgets`).
You can then use the facade's `addSegment` method with your extended `Monitoring` class.

### Custom dashboards

If you want *even* more flexibility, you can take complete control over dashboard generation by leveraging dynamic dashboarding features. This allows you to create an arbitrary number of dashboards while configuring each of them separately. You can do this in three simple steps:
Expand Down

0 comments on commit aeb91fb

Please sign in to comment.