Genie Profile JSON configuration string

The following sections contain information that pertain to the format of the JSON configuration string that is supplied to GenieProfileConfig_createFromJson. This JSON configuration can also be provided in certain genie-app commands.

Note

Please refer to the example configs contained in the SDK at ${SDK_ROOT}/examples/Genie/configs/profile/.

General configuration schema

The following provides the schema of the JSON configuration format that is provided to GenieProfileConfig_createFromJson. Note that dependencies are not specified in the schema, but are discussed in the following per-backend sections.

{
  {
    "profile" : {
      "type" : "object",
      "properties" : {
        "version" : {"type" : "integer"},
        "trace" : {
          "type" : "object",
          "properties": {
            "version" : {"type" : "integer"},
            "enable" : {"type" : "boolean"}
          }
        }
      }
    }
  }
}

Option

Description

profile::version

Version of profile object that is supported by APIs.(1)

profile::trace::version

Version of profile trace object that is supported by APIs.(1)

profile::trace::enable

Flag to enable or disable trace profiling.

An example of a trace-enabled profile configuration can be found at ${SDK_ROOT}/examples/Genie/configs/profile/trace.json.