Skip to main content
Options allow an agent to be configured or tweaked at runtime. All options, unless specified as optional, will be provided to the agent by the server as environment variables. An agent that has required options with no default values will require the user to specify values for those options. 
[options.EXAMPLE_OPTION]
type = "string"

[options.EXAMPLE_REQUIRED_OPTION]
type = "string"
required = true

[options.EXAMPLE_DEFAULT_OPTION]
type = "string"
default = "default value for this option"

​
Requirements

  • Option names must be between 1 and 256 characters
  • Option names must begin with an alphanumeric character
  • An agent may only specify 512 options
  • The combined size of all default values for all options may not exceed 6 MiB

​
Types

All options must specify a type. Different option types have different fields. Available option types:
TypeList typeDescription
i8list[i8]8-bit signed integer
i16list[i16]16-bit signed integer
i32list[i32]32-bit signed integer
i64list[i64]64-bit signed integer
u8list[u8]8-bit unsigned integer
u16list[u16]16-bit unsigned integer
u32list[u32]32-bit unsigned integer
u64list[u64]64-bit unsigned integer
f32list[f32]32-bit floating-point number
f64list[f64]64-bit floating-point number
bool—Boolean value
stringlist[string]UTF-8 string
bloblist[blob]Binary data