Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 2.23 KB

README.md

File metadata and controls

47 lines (37 loc) · 2.23 KB

Examples

This directory contains example configurations for LoadTests in each supported language.

To see all available options for the LoadTest, please visit the LoadTest definition in loadtest_types.go.

To see all available options for the scenariosJSON embedded in the test, please visit the definition in control.proto, in the repository grpc/grpc-proto.

The examples in this folder are basic examples that build and run the test components when the test is applied, and do not save data to BigQuery. These can be run by applying them to the cluster with kubectl apply -f.

The examples in the templates folder are templates that use prebuilt images and require parameter substitution before running. Tools are provided to build images and run tests with the correct parameters.

All examples are generated from templates stored in the grpc/grpc repository. For more information, please visit the gRPC OSS benchmarks README on grpc/grpc.

Examples for PSM benchmarks can be found here.

Prometheus is used to monitor CPU and memory utilization in PSM benchmarks. Prometheus monitoring can be enabled for any other test by adding the annotation enablePrometheus: 'true' to the LoadTest configuration. For context, see grpc#315.

Special considerations is required for running csharp examples. These examples correspond to the legacy C# implementation in grpc/grpc. This implementation was removed by grpc/grpc#29225, and is only supported in version v1.46.x and earlier versions of grpc/grpc. For the newer C# implementation in grpc/grpc-dotnet, see the dotnet examples.