@cloudsnorkel/cdk-github-runners 0.10.8 → 0.11.1

package/API.md

@@ -3199,6 +3199,7 @@ new GitHubRunners(scope: Construct, id: string, props?: GitHubRunnersProps)
 | **Name** | **Description** |
 | --- | --- |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunners.toString">toString</a></code> | Returns a string representation of this construct. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunners.createLogsInsightsQueries">createLogsInsightsQueries</a></code> | Creates CloudWatch Logs Insights saved queries that can be used to debug issues with the runners. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunners.failedImageBuildsTopic">failedImageBuildsTopic</a></code> | Creates a topic for notifications when a runner image build fails. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunners.metricFailed">metricFailed</a></code> | Metric for failed runner executions. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunners.metricJobCompleted">metricJobCompleted</a></code> | Metric for the number of GitHub Actions jobs completed. |
@@ -3215,6 +3216,19 @@ public toString(): string
 
 Returns a string representation of this construct.
 
+##### `createLogsInsightsQueries` <a name="createLogsInsightsQueries" id="@cloudsnorkel/cdk-github-runners.GitHubRunners.createLogsInsightsQueries"></a>
+
+```typescript
+public createLogsInsightsQueries(): void
+```
+
+Creates CloudWatch Logs Insights saved queries that can be used to debug issues with the runners.
+
+* "Webhook errors" helps diagnose configuration issues with GitHub integration
+* "Ignored webhook" helps understand why runners aren't started
+* "Ignored jobs based on labels" helps debug label matching issues
+* "Webhook started runners" helps understand which runners were started
+
 ##### `failedImageBuildsTopic` <a name="failedImageBuildsTopic" id="@cloudsnorkel/cdk-github-runners.GitHubRunners.failedImageBuildsTopic"></a>
 
 ```typescript
@@ -3825,7 +3839,7 @@ Included components:
  * `RunnerImageComponent.githubRunner()`
  * `RunnerImageComponent.lambdaEntrypoint()`
 
- Base Docker image: `public.ecr.aws/lambda/nodejs:14-x86_64` or `public.ecr.aws/lambda/nodejs:14-arm64`
+ Base Docker image: `public.ecr.aws/lambda/nodejs:16-x86_64` or `public.ecr.aws/lambda/nodejs:16-arm64`
 
 ###### `scope`<sup>Required</sup> <a name="scope" id="@cloudsnorkel/cdk-github-runners.LambdaRunner.imageBuilder.parameter.scope"></a>
 
@@ -4185,7 +4199,7 @@ Included components:
  * `RunnerImageComponent.githubRunner()`
  * `RunnerImageComponent.lambdaEntrypoint()`
 
- Base Docker image: `public.ecr.aws/lambda/nodejs:14-x86_64` or `public.ecr.aws/lambda/nodejs:14-arm64`
+ Base Docker image: `public.ecr.aws/lambda/nodejs:16-x86_64` or `public.ecr.aws/lambda/nodejs:16-arm64`
 
 ###### `scope`<sup>Required</sup> <a name="scope" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.imageBuilder.parameter.scope"></a>
 

package/README.md

@@ -280,6 +280,16 @@ Runners are started in response to a webhook coming in from GitHub. If there are
    2. If you see too many errors, make sure you're only sending `workflow_job` events
 5. When using GitHub app, make sure there are active installations in `github.auth.app.installations`
 
+All logs are saved in CloudWatch.
+* Log group names can be found in `status.json` for each provider, image builder, and other parts of the system
+* Some useful Logs Insights queries can be enabled with `GitHubRunners.createLogsInsightsQueries()`
+
+To get `status.json`, check out the CloudFormation stack output for a command that generates it. The command looks like:
+
+```
+aws --region us-east-1 lambda invoke --function-name status-XYZ123 status.json
+```
+
 ## Monitoring
 
 There are two important ways to monitor your runners: