Skip to content

Commit 78c765a

Browse files
committed
Merge remote-tracking branch 'upstream/main'
2 parents dd25e81 + 1692725 commit 78c765a

File tree

19 files changed

+294
-48
lines changed

19 files changed

+294
-48
lines changed

.github/workflows/docbuild.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: ci
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- main
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: actions/setup-python@v4
15+
with:
16+
python-version: 3.x
17+
- run: pip install mkdocs-material
18+
- run: mkdocs gh-deploy --force

.github/workflows/linkcheck.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"timeout": "5s",
3+
"retryOn429": true,
4+
"retryCount": 5,
5+
"fallbackRetryDelay": "30s",
6+
"aliveStatusCodes": [200, 206],
7+
"httpHeaders": [
8+
{
9+
"urls": ["https://help.github.com/"],
10+
"headers": {
11+
"Accept-Encoding": "zstd, br, gzip, deflate"
12+
}
13+
}
14+
],
15+
"ignorePatterns": [
16+
{
17+
"pattern": [
18+
"localhost"
19+
]
20+
},
21+
{
22+
"pattern": [
23+
"127.0.0.1"
24+
]
25+
}
26+
]
27+
}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Check Markdown links
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- "**/*.md"
9+
10+
pull_request:
11+
branches:
12+
- main
13+
paths:
14+
- "**/*.md"
15+
16+
jobs:
17+
markdown-link-check:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v3
21+
- uses: actions/setup-node@v3
22+
with:
23+
node-version: '16.x'
24+
- name: install markdown-link-check
25+
run: npm install -g [email protected]
26+
- name: markdown-link-check version
27+
run: npm list -g markdown-link-check
28+
- name: Run markdown-link-check on MD files
29+
run: find docs -name "*.md" | xargs -n 1 markdown-link-check -q -c .github/workflows/linkcheck.json
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: 'Stale issue & PR handler'
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: '0 0 * * *'
6+
7+
jobs:
8+
stale:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
issues: write
12+
pull-requests: write
13+
steps:
14+
- uses: actions/stale@main
15+
id: stale
16+
with:
17+
ascending: true
18+
close-issue-message: 'Issue closed due to inactivity.'
19+
close-pr-message: 'Pull request closed due to inactivity.'
20+
days-before-close: 60
21+
days-before-stale: 90
22+
stale-issue-label: stale
23+
stale-pr-label: stale
24+
# Not stale if have this labels
25+
exempt-issue-labels: 'bug,enhancement,"feature request"'
26+
exempt-pr-labels: 'bug,enhancement'
27+
operations-per-run: 100
28+
stale-issue-message: |
29+
This issue has been automatically marked as stale because it has been open 60 days
30+
with no activity. Remove stale label or comment or this issue will be closed in 10 days
31+
stale-pr-message: |
32+
This PR has been automatically marked as stale because it has been open 60 days
33+
with no activity. Remove stale label or comment or this PR will be closed in 10 days

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1-
# AWS Observability Accelerator for AWS CDK
1+
# AWS Observability Accelerator for CDK
22

33
Welcome to the AWS Observability Accelerator for CDK!
44

55
The AWS Observability Accelerator for CDK is a set of opinionated modules
6-
to help you set up observability for your AWS environments with AWS-managed observability services such as Amazon Managed Service for Prometheus,Amazon Managed Grafana, AWS Distro for OpenTelemetry (ADOT) and Amazon CloudWatch.
6+
to help you set up observability for your AWS environments with AWS Native services and AWS-managed observability services such as Amazon Managed Service for Prometheus,Amazon Managed Grafana, AWS Distro for OpenTelemetry (ADOT) and Amazon CloudWatch.
77

88
We provide curated metrics, logs, traces collection, alerting rules and Grafana dashboards for your EKS infrastructure, Java/JMX, NGINX based workloads and your custom applications.
99

10+
## Single EKS Cluster AWS Native Observability Accelerator
11+
12+
![AWSNative-Architecture](https://github.com/aws-observability/cdk-aws-observability-accelerator/blob/main/docs/images/cloud-native-arch.png?raw=true)
13+
14+
## Singe EKS Cluster Open Source Observability Accelerator
15+
16+
![OpenSource-Architecture](https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/811ec42307d41f35f2fec95f2f2b8a20bddc7646/docs/images/CDK_Architecture_diagram.png)
17+
1018
## Patterns
1119

1220
The individual patterns can be found in the `lib` directory. Most of the patterns are self-explanatory, for some more complex examples please use this guide and docs/patterns directory for more information.
@@ -165,7 +173,7 @@ await prevalidateSecrets("my-pattern-name", 'us-east-1', 'my-secret-name'); //
165173

166174
## Security
167175

168-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
176+
See [CONTRIBUTING](./contributors.md#security-issue-notifications) for more information.
169177

170178
## License
171179

docs/contributors.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributors
2+
3+
The content on this site is maintained by the Solutions Architects from the
4+
AWS observability team with support from the AWS service teams and other
5+
volunteers from across the organization.
6+
7+
Our goal is to make it easier to use AWS Native and Open Source Observability Services.
8+
9+
The core team include the following people:
10+
11+
* Elamaran Shanmugam
12+
* Imaya Kumar Jagannathan
13+
* Kevin Lewin
14+
* Michael Hausenblas
15+
* Mikhail Shapirov
16+
* Rodrigue Koffi
17+
18+
We welcome the wider open source community and thank [those who contribute](https://github.com/aws-observability/cdk-aws-observability-accelerator/graphs/contributors)
19+
to this project.
20+
21+
Note that all information published on this site is available via the
22+
Apache 2.0 license.
250 KB
Loading

docs/images/aws-favicon.png

392 Bytes
Loading

docs/images/aws-logo.png

3.58 KB
Loading

docs/images/cloud-native-arch.png

648 KB
Loading

0 commit comments

Comments
 (0)