Capture githubRateLimitRemaining metric in CloudWatch

Author: mikebroberts

package-lock.json

@@ -40,6 +40,7 @@
   },
   "dependencies": {
     "@aws-lambda-powertools/logger": "2.x",
+    "@aws-lambda-powertools/metrics": "2.x",
     "@aws-lambda-powertools/parameters": "2.x",
     "@aws-lambda-powertools/tracer": "2.x",
     "@aws-sdk/client-athena": "3.x",

package.json

@@ -5,6 +5,7 @@ import { crawlRepositories } from './crawlRepositories'
 import { crawlPushes } from './crawlPushes'
 import { crawlWorkflowRunEvents } from './crawlRunEvents'
 import { logger } from '../../../util/logging'
+import { publishGithubInstallationClientMetrics } from '../../../outboundInterfaces/githubInstallationClient'
 
 export async function crawlInstallation(
   appState: AppState,
@@ -14,7 +15,7 @@ export async function crawlInstallation(
   logger.info(`Crawling Installation for ${installation.accountLogin}`)
   const githubInstallationClient = appState.githubClient.clientForInstallation(installation.installationId)
   await crawlUsers(appState, installation, githubInstallationClient)
-  logger.info('Github Metadata after crawling users', { ...githubInstallationClient.meta() })
+  publishGithubInstallationClientMetrics(installation, githubInstallationClient)
   const repos = await crawlRepositories(appState, installation, githubInstallationClient)
   // Eventually consider doing some parallelization here (or move back to step function) but
   // need to be careful since GitHub gets twitchy about concurrent requests to the API
@@ -24,6 +25,6 @@ export async function crawlInstallation(
     await crawlPushes(appState, installation, repo, githubInstallationClient)
     await crawlWorkflowRunEvents(appState, installation, repo, lookbackDays, githubInstallationClient)
   }
-
+  publishGithubInstallationClientMetrics(installation, githubInstallationClient)
   logger.info('Github Metadata after crawls', { ...githubInstallationClient.meta() })
 }

src/app/domain/github/crawler/crawlInstallation.ts

@@ -2,8 +2,11 @@ import { injectLambdaContext } from '@aws-lambda-powertools/logger/middleware'
 import { logger } from '../util/logging'
 import { captureLambdaHandler } from '@aws-lambda-powertools/tracer/middleware'
 import { tracer } from '../util/tracing'
+import { logMetrics } from '@aws-lambda-powertools/metrics/middleware'
+import { metrics } from '../util/metrics'
 
 const loggingMiddleware = injectLambdaContext(logger)
+const metricsMiddleware = logMetrics(metrics, { captureColdStartMetric: false, throwOnEmptyMetrics: false })
 const tracingMiddleware = captureLambdaHandler(tracer)
 
-export const powertoolsMiddlewares = [loggingMiddleware, tracingMiddleware]
+export const powertoolsMiddlewares = [loggingMiddleware, metricsMiddleware, tracingMiddleware]

src/app/middleware/standardMiddleware.ts

@@ -4,6 +4,9 @@ import { RawGithubWorkflowRunEvent } from '../domain/types/rawGithub/RawGithubWo
 import { RawGithubRepository } from '../domain/types/rawGithub/RawGithubRepository'
 import { RawGithubUser } from '../domain/types/rawGithub/RawGithubUser'
 import { RawGithubEvent } from '../domain/types/rawGithub/RawGithubEvent'
+import { GithubInstallation } from '../domain/types/GithubInstallation'
+import { metrics } from '../util/metrics'
+import { MetricUnit } from '@aws-lambda-powertools/metrics'
 
 export interface GithubInstallationClient {
   listWorkflowRunsForRepo(owner: string, repo: string, created?: string): Promise<RawGithubWorkflowRunEvent[]>
@@ -127,3 +130,17 @@ export type OctokitResponseHeaders = {
   'x-ratelimit-reset'?: string
   'x-ratelimit-used'?: string
 }
+
+// ToEventually - move this into the actual GithubInstallationClient object
+export function publishGithubInstallationClientMetrics(
+  installation: GithubInstallation,
+  githubInstallationClient: GithubInstallationClient
+) {
+  const rateLimitMetric = metrics.singleMetric()
+  rateLimitMetric.addDimension('installationAccount', installation.accountLogin)
+  rateLimitMetric.addMetric(
+    'githubRateLimitRemaining',
+    MetricUnit.Count,
+    githubInstallationClient.meta().ratelimitRemaining
+  )
+}

src/app/outboundInterfaces/githubInstallationClient.ts

@@ -0,0 +1,5 @@
+import { Metrics } from '@aws-lambda-powertools/metrics'
+
+// Configuration in Lambda env is defined in CDK for when this is used in a Lambda environment
+// E.g. look for POWERTOOLS_ ... env vars
+export const metrics = new Metrics({})