x-codeguru_profiler

Syntax

Properties: {}
MacroParameters: {}
Lookup: {}
Services: []

Hint

Using ECS ComposeX, this automatically adds an Environment variable to your container, and AWS_CODEGURU_PROFILER_GROUP_NAME of the newly created Profiling Group.

Hint

If you do not specify any Properties, the Profiling group name gets generated for you.

Tip

You can find the test files here to use as reference for your use-case.

See also

For more structural details, see JSON Schema

Properties

Ths properties allow to use the same definition as in AWS Syntax Reference.

MacroParameters

AppendStackId

Type: Boolean Description: Allows you to automatically add the stack ID to the provided Profiling Group Name so you can have multiple profiling groups of the same logical name in your compose definition but different names when deploying to the same account and same AWS region.

Tip

We recommend to set the value to True at all times, but did not make it default.

Lookup

See Lookup for syntax.

Note

For Lookup as when you create it, the profiling group name is available via AWS_CODEGURU_PROFILER_GROUP_NAME environment variable.

Example

x-codeguru_profiler:
    Profiler01:
      Properties: {}
    Services:
        - name: service01
          access: RW

Attention

The only valid access mode is RW

Code Example

Full Applications code used for this sort of testing can be found here

JSON Schema

services.x-codeguru_profiler specification

services.x-codeguru_profiler

The services.x-codeguru_profiler specification for ComposeX

oneOf

type

string

type

boolean

type

object

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "services.x-logging.spec.json",
  "id": "services.x-codeguru_profiler",
  "title": "services.x-codeguru_profiler specification",
  "description": "The services.x-codeguru_profiler specification for ComposeX",
  "oneOf": [
    {
      "type": "string"
    },
    {
      "type": "boolean"
    },
    {
      "type": "object"
    }
  ]
}