fix: define user agent

Author: npalm

examples/default/main.tf

@@ -98,7 +98,7 @@ module "runners" {
   }
 
   # Enable debug logging for the lambda functions
-  # log_level = "debug"
+  log_level = "debug"
 
   # tracing_config = {
   #   mode                  = "Active"

lambdas/functions/control-plane/src/github/auth.ts

@@ -29,6 +29,7 @@ export async function createOctokitClient(token: string, ghesApiUrl = ''): Promi
 
   return new CustomOctokit({
     ...ocktokitOptions,
+    userAgent: process.env.USER_AGENT || 'aws-github-runner',
     throttle: {
       onRateLimit: (retryAfter: number, options: Required<EndpointDefaults>) => {
         logger.warn(

main.tf

@@ -256,6 +256,7 @@ module "runners" {
 
   ghes_url        = var.ghes_url
   ghes_ssl_verify = var.ghes_ssl_verify
+  user_agent      = var.user_agent
 
   kms_key_arn = var.kms_key_arn
 

modules/multi-runner/runners.tf

@@ -102,6 +102,7 @@ module "runners" {
 
   ghes_url        = var.ghes_url
   ghes_ssl_verify = var.ghes_ssl_verify
+  user_agent      = var.user_agent
 
   kms_key_arn = var.kms_key_arn
 

modules/multi-runner/variables.tf

@@ -671,3 +671,9 @@ variable "eventbridge" {
 
   default = {}
 }
+
+variable "user_agent" {
+  description = "User agent used for API calls by lambda functions."
+  type        = string
+  default     = "aws-github-runner"
+}

modules/runners/job-retry/main.tf

@@ -7,6 +7,7 @@ locals {
     ENABLE_METRIC_JOB_RETRY              = var.config.metrics.enable && var.config.metrics.metric.enable_job_retry
     ENABLE_METRIC_GITHUB_APP_RATE_LIMIT  = var.config.metrics.enable && var.config.metrics.metric.enable_github_app_rate_limit
     GHES_URL                             = var.config.ghes_url
+    USER_AGENT                           = var.config.user_agent
     JOB_QUEUE_SCALE_UP_URL               = var.config.sqs_build_queue.url
     PARAMETER_GITHUB_APP_ID_NAME         = var.config.github_app_parameters.id.name
     PARAMETER_GITHUB_APP_KEY_BASE64_NAME = var.config.github_app_parameters.key_base64.name

modules/runners/job-retry/variables.tf

@@ -8,6 +8,7 @@ variable "config" {
     `enable_organization_runners`: Enable organization runners.
     `enable_metric`: Enable metric for the lambda. If `spot_warning` is set to true, the lambda will emit a metric when it detects a spot termination warning.
     'ghes_url': Optional GitHub Enterprise Server URL.
+    'user_agent': Optional User-Agent header for GitHub API requests.
     'github_app_parameters': Parameter Store for GitHub App Parameters.
     'kms_key_arn': Optional CMK Key ARN instead of using the default AWS managed key.
     `lambda_principals`: Add extra principals to the role created for execution of the lambda, e.g. for local testing.
@@ -39,6 +40,7 @@ variable "config" {
     enable_organization_runners = bool
     environment_variables       = optional(map(string), {})
     ghes_url                    = optional(string, null)
+    user_agent                  = optional(string, null)
     github_app_parameters = object({
       key_base64 = map(string)
       id         = map(string)

modules/runners/pool.tf

@@ -9,6 +9,7 @@ module "pool" {
       ssl_verify = var.ghes_ssl_verify
       url        = var.ghes_url
     }
+    user_agent                    = var.user_agent
     github_app_parameters         = var.github_app_parameters
     instance_allocation_strategy  = var.instance_allocation_strategy
     instance_max_spot_price       = var.instance_max_spot_price

modules/runners/pool/main.tf

@@ -23,6 +23,7 @@ resource "aws_lambda_function" "pool" {
       ENABLE_JIT_CONFIG                        = var.config.runner.enable_jit_config
       ENVIRONMENT                              = var.config.prefix
       GHES_URL                                 = var.config.ghes.url
+      USER_AGENT                               = var.config.user_agent
       INSTANCE_ALLOCATION_STRATEGY             = var.config.instance_allocation_strategy
       INSTANCE_MAX_SPOT_PRICE                  = var.config.instance_max_spot_price
       INSTANCE_TARGET_CAPACITY_TYPE            = var.config.instance_target_capacity_type

modules/runners/pool/variables.tf

@@ -64,6 +64,7 @@ variable "config" {
     ami_id_ssm_parameter_read_policy_arn = string
     arn_ssm_parameters_path_config       = string
     lambda_tags                          = map(string)
+    user_agent                           = string
   })
 }
 

modules/runners/scale-down.tf

@@ -25,6 +25,7 @@ resource "aws_lambda_function" "scale_down" {
       ENVIRONMENT                              = var.prefix
       ENABLE_METRIC_GITHUB_APP_RATE_LIMIT      = var.metrics.enable && var.metrics.metric.enable_github_app_rate_limit
       GHES_URL                                 = var.ghes_url
+      USER_AGENT                               = var.user_agent
       LOG_LEVEL                                = var.log_level
       MINIMUM_RUNNING_TIME_IN_MINUTES          = coalesce(var.minimum_running_time_in_minutes, local.min_runtime_defaults[var.runner_os])
       NODE_TLS_REJECT_UNAUTHORIZED             = var.ghes_url != null && !var.ghes_ssl_verify ? 0 : 1

modules/runners/scale-up.tf

@@ -34,6 +34,7 @@ resource "aws_lambda_function" "scale_up" {
       ENABLE_ORGANIZATION_RUNNERS              = var.enable_organization_runners
       ENVIRONMENT                              = var.prefix
       GHES_URL                                 = var.ghes_url
+      USER_AGENT                               = var.user_agent
       INSTANCE_ALLOCATION_STRATEGY             = var.instance_allocation_strategy
       INSTANCE_MAX_SPOT_PRICE                  = var.instance_max_spot_price
       INSTANCE_TARGET_CAPACITY_TYPE            = var.instance_target_capacity_type

modules/runners/variables.tf

@@ -733,3 +733,9 @@ variable "job_retry" {
     error_message = "The maxium message delay for SWS is 900 seconds."
   }
 }
+
+variable "user_agent" {
+  description = "User agent used for API calls."
+  type        = string
+  default     = null
+}

variables.tf

@@ -952,3 +952,9 @@ EOF
 
   default = {}
 }
+
+variable "user_agent" {
+  description = "User agent used for API calls by lambda functions."
+  type        = string
+  default     = "aws-github-runner"
+}