package salvo

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: SourceRepository

• string parameter = 1

  A string containing the entire compiler option and value that is supplied to bazel when compiling a project. eg. " --jobs 4" or "--define tcmalloc=gperftools"

Capture all docker images required for the benchmark. This object is examined first before evaluating the state of specified source locations

Determines whether required docker are used if they already exist. The benchmark image and binary image must be specified. If this is set to false there must be a specified source location from which we build the image

Used in: JobControl

• bool reuse_nh_images = 1

  This should be implicit. Images are preferred over building from source. We build only if the image pull is not successful and sources are present

• string nighthawk_benchmark_image = 2

  Specifies the name of the docker image containing the benchmark framework If populated we will attempt to pull this image eg: "envoyproxy/nighthawk-benchmark-dev:latest"

• string nighthawk_binary_image = 3

  Specifies the name of the docker image containing nighthawk binaries eg: "envoyproxy/nighthawk-dev:latest"

• string envoy_image = 4

  Specifies the envoy image from which Envoy is injected. This supports using a commit hash or a tag to identify a specific image eg: "envoyproxy/envoy-dev:f61b096f6a2dd3a9c74b9a9369a6ea398dbe1f0f"

• repeated string additional_envoy_images = 5

  Specifies additional images for which we benchmark for analysis. In this field one can specify list of image strings. The framework will execute an additional benchmark run for each entry specified. If this field is not specified, we will deduce one commit or tag prior to the "envoy_image" defined and benchmark the discovered image. eg: [ "envoyproxy/envoy-dev:7da2adee8962c202999e96cb41e899deb34faf48",..]

• bool test_single_image = 6

  If this field is true and additional_envoy_images is not defined, we will only test envoy image which is defined in envoy_image field. It's useful for the scenario that someone want to test different configuration with specific envoy image. test_single_image and additional_envoy_images are mutually exclusive and cannot be defined at the same time.

Capture all Environment variables required for the benchmark

Used in: JobControl

• EnvironmentVars.TestIpVersion test_version = 1

• string envoy_path = 2

  Controls whether envoy is placed between the nighthawk client and server

• string output_dir = 3

  Specify the output directory for nighthawk artifacts eg: "/home/user/test_output_path"

• string test_dir = 4

  Specify the directory where external tests are located eg: "/home/user/nighthawk_external_tests"

• map<string, string> variables = 5

  Additional environment variables that may be needed for operation

Specify the IP version for tests

Used in: EnvironmentVars

• IPV_UNSPECIFIED = 0

• IPV_V4ONLY = 1

• IPV_V6ONLY = 2

• IPV_ALL = 3

This message type defines the schema for the consumed data file controlling the benchmark being executed. In it a user will define whether the benchmark uses images only, builds images from source, and whether the benchark executes locally or remotely.

• bool remote = 1

  Specify whether the benchmark runs locally or in a service

• oneof benchmark

  Specify the benchmark to execute

  • bool scavenging_benchmark = 2

  • bool dockerized_benchmark = 3

  • bool binary_benchmark = 4

• repeated SourceRepository source = 6

  Define where we find all required sources

• optional DockerImages images = 7

  Define the names of all required docker images

• optional EnvironmentVars environment = 8

  Define the environment variables needed for the test

Capture the location of sources needed for the benchmark

Used in: JobControl

• SourceRepository.SourceIdentity identity = 1

• oneof source_location

  • string source_path = 2

    Specify the location of the source repository on disk. If specified this location is used to determine the origin url, branch, and commit hash. If not specified, the remaining fields must be populated eg: "/home/user/code/envoy"

  • string source_url = 3

    Specify the remote location of the repository. eg: "https://github.com/envoyproxy/envoy.git"

• string branch = 4

  Specify the local working branch. This is ignored if the source location is specified.

• string commit_hash = 5

  Specify a commit hash if applicable. If not specified we will determine this from the source tree. We will also use this field to identify the corresponding NightHawk or Envoy image used for the benchmark

• repeated string additional_hashes = 6

  Specify a set of additional hashes for comparing benchmark results. This field is optional and if unspecified, we will default to using one commit prior to the specified "commit_hash" field. For each hash specfied we will run a benchmark using the Envoy binary built from that source commit

• repeated BazelOption bazel_options = 7

  A list of compiler options and flags to supply to bazel when building the source of NightHawk or Envoy

• bool test_single_commit = 8

  If this field is true and additional_hashes is not defined, we will only test envoy commit which is defined in commit_hash field. It's useful for the scenario that someone want to test different configuration with specific envoy commit. test_single_commit and additional_hashes are mutually exclusive and cannot be defined at the same time

Specify whether this source location is Envoy or NightHawk

Used in: SourceRepository

• SRCID_UNSPECIFIED = 0

• SRCID_ENVOY = 1

• SRCID_NIGHTHAWK = 2

This message defines the volume structure consumed by the command to run a docker image.

• map<string, VolumeProperties> volumes = 1

  Specify a map of local paths and their mount points in the container

This message defines the properties for a mount point.

Used in: Volume

• string bind = 1

  Specify the destination mount path in the benchmark container

• string mode = 2

  Specify whether the volume is read-write or read-only. This field must be a string that is populated with 'rw' or 'ro' internally