nighthawk

(★ 412)

L7 (HTTP/HTTPS/HTTP2/HTTP3) performance characterization tool

File Explorer

Download Latest Version (.zip)

- - bug.md
  - feature_request.md
  - PULL_REQUEST_TEMPLATE.md
- - _ci.yml
  - nighthawk.yml
  - scorecard.yml
- config.yml
- dependabot.yml
- launch.json
- README.md
- settings.json
- tasks.json
- tasks.png
- - adaptive_load.proto
  - benchmark_result.proto
  - BUILD
  - input_variable_setter_impl.proto
  - metric_spec.proto
  - metrics_plugin_impl.proto
  - scoring_function_impl.proto
  - step_controller_impl.proto
- - BUILD
  - options.proto
  - output.proto
  - service.proto
- - BUILD
  - cluster_config_manager.proto
  - endpoints_config_manager.proto
  - README.md
- - BUILD
  - distributor.proto
- - BUILD
  - linear_ramping_rate_limiter.proto
  - stub_rate_limiter.proto
- - BUILD
  - request_source_plugin.proto
  - service.proto
- - BUILD
  - dynamic_delay.proto
  - response_options.proto
  - time_tracking.proto
- - BUILD
  - sink.proto
- - BUILD
  - log_response_headers.proto
- BUILD
- engflow-bazel-credential-helper.sh
- get_workspace_status
- python_dependencies.bzl
- repositories.bzl
- - dynamic_resources.yaml
  - dynamic_resources_eds.yaml
  - envoy_proxy.yaml
  - lds.yaml
  - request_source_five_clusters.json
- - docker_build.sh
  - Dockerfile-benchmark
- - test_cds_churn_with_traffic.py
  - test_eds_churn_with_traffic.py
- - simple_plot.html
- - README.md
  - test_discovery.py
- .gitignore
- benchmark-visual-example.png
- BUILD
- dynamic_benchmarks.py
- dynamic_config_envoy_proxy.py
- envoy_proxy.py
- README.md
- run_benchmark.sh
- static_benchmarks.py
- utilities.py
- - benchmark_build.sh
  - benchmark_push.sh
  - default-config.yaml
  - docker_build.sh
  - docker_push.sh
  - Dockerfile-nighthawk
  - Dockerfile-nighthawk-benchmark
- do_ci.sh
- docker-compose.yml
- envoy_build_sha.sh
- run_clang_tidy.sh
- run_envoy_docker.sh
- - adaptive_load_controller.md
  - navigating_the_codebase.md
  - overview.md
  - statistics.md
  - terminology.md
  - updating_envoy_dependency.md
  - version_history.md
- BUILD
- dynamic_config_manager.py
- dynamic_config_server.py
- README.md
- - BUILD
  - statistic.proto
- README.md
- - large.json
  - small.json
- - large.png
  - small.png
- - adaptive_load_client_main.cc
  - adaptive_load_client_main.h
  - adaptive_load_controller_impl.cc
  - adaptive_load_controller_impl.h
  - BUILD
  - config_validator_impl.cc
  - config_validator_impl.h
  - input_variable_setter_impl.cc
  - input_variable_setter_impl.h
  - metrics_evaluator_impl.cc
  - metrics_evaluator_impl.h
  - metrics_plugin_impl.cc
  - metrics_plugin_impl.h
  - plugin_loader.cc
  - plugin_loader.h
  - scoring_function_impl.cc
  - scoring_function_impl.h
  - session_spec_proto_helper_impl.cc
  - session_spec_proto_helper_impl.h
  - step_controller_impl.cc
  - step_controller_impl.h
- - benchmark_client_impl.cc
  - benchmark_client_impl.h
  - BUILD
  - client.cc
  - client.h
  - client_worker_impl.cc
  - client_worker_impl.h
  - factories_impl.cc
  - factories_impl.h
  - flush_worker_impl.cc
  - flush_worker_impl.h
  - options_impl.cc
  - options_impl.h
  - output_collector_impl.cc
  - output_collector_impl.h
  - output_formatter_impl.cc
  - output_formatter_impl.h
  - output_transform_main.cc
  - output_transform_main.h
  - process_bootstrap.cc
  - process_bootstrap.h
  - process_impl.cc
  - process_impl.h
  - remote_process_impl.cc
  - remote_process_impl.h
  - service_impl.cc
  - service_impl.h
  - service_main.cc
  - service_main.h
  - sni_utility.cc
  - sni_utility.h
  - stream_decoder.cc
  - stream_decoder.h
- - BUILD
  - cached_time_source_impl.h
  - frequency.h
  - nighthawk_service_client_impl.cc
  - nighthawk_service_client_impl.h
  - phase_impl.cc
  - phase_impl.h
  - platform_util_impl.h
  - rate_limiter_impl.cc
  - rate_limiter_impl.h
  - request_impl.h
  - request_source_impl.cc
  - request_source_impl.h
  - request_stream_grpc_client_impl.cc
  - request_stream_grpc_client_impl.h
  - sequencer_impl.cc
  - sequencer_impl.h
  - signal_handler.cc
  - signal_handler.h
  - statistic_impl.cc
  - statistic_impl.h
  - termination_predicate_impl.cc
  - termination_predicate_impl.h
  - thread_safe_monotonic_time_stopwatch.cc
  - thread_safe_monotonic_time_stopwatch.h
  - uri_impl.cc
  - uri_impl.h
  - utility.cc
  - utility.h
  - version_info.cc
  - version_info.h
  - version_linkstamp.cc
  - worker_impl.cc
  - worker_impl.h
- - BUILD
  - nighthawk_distributor_client_impl.cc
  - nighthawk_distributor_client_impl.h
  - service_impl.cc
  - service_impl.h
- - adaptive_load_client_main_entry.cc
  - BUILD
  - client_main_entry.cc
  - output_transform_main_entry.cc
  - service_main_entry.cc
- - BUILD
  - llm_request_source_plugin.proto
  - llm_request_source_plugin_impl.cc
  - llm_request_source_plugin_impl.h
  - request_options_list_plugin_impl.cc
  - request_options_list_plugin_impl.h
- - BUILD
  - configuration.cc
  - configuration.h
  - http_dynamic_delay_filter.cc
  - http_dynamic_delay_filter.h
  - http_dynamic_delay_filter_config.cc
  - http_filter_config_base.cc
  - http_filter_config_base.h
  - http_test_server_filter.cc
  - http_test_server_filter.h
  - http_test_server_filter_config.cc
  - http_time_tracking_filter.cc
  - http_time_tracking_filter.h
  - http_time_tracking_filter_config.cc
  - README.md
  - well_known_headers.h
- - BUILD
  - nighthawk_sink_client_impl.cc
  - nighthawk_sink_client_impl.h
  - service_impl.cc
  - service_impl.h
  - sink_impl.cc
  - sink_impl.h
- - BUILD
  - log_response_headers_plugin.cc
  - log_response_headers_plugin.h
  - user_defined_output_plugin_creator.cc
  - user_defined_output_plugin_creator.h
- BUILD
- - pre-push
  - prepare-commit-msg
- bootstrap
- README.md
- - adaptive_load_client_main_test.cc
  - adaptive_load_controller_test.cc
  - BUILD
  - input_variable_setter_test.cc
  - metrics_evaluator_test.cc
  - metrics_plugin_test.cc
  - minimal_output.cc
  - minimal_output.h
  - plugin_loader_test.cc
  - scoring_function_test.cc
  - session_spec_proto_helper_test.cc
  - step_controller_test.cc
- - BUILD
  - utility.cc
  - utility.h
- - BUILD
  - fake_time_source.cc
  - fake_time_source.h
  - fake_time_source_test.cc
  - nighthawk_service_client_test.cc
  - signal_handler_test.cc
- - BUILD
  - README.md
- - BUILD
  - distributor_service_test.cc
  - nighthawk_distributor_client_test.cc
- - BUILD
  - dynamic_config_manager_test.py
- - asserts.py
  - BUILD
  - common.py
  - integration_test.py
  - integration_test_fixtures.py
  - nighthawk_grpc_service.py
  - nighthawk_test_server.py
  - subprocess_mixin.py
  - test_connection_management.py
  - test_grpc_service.py
  - test_integration_basics.py
  - test_integration_zipkin.py
  - test_output_transform.py
  - test_rate_limiter_plugin.py
  - test_remote_execution.py
  - test_request_source_plugin.py
  - test_user_defined_output_plugins.py
  - utility.py
- - BUILD
  - llm_request_source_plugin_test.cc
  - request_source_plugin_test.cc
  - stub_plugin_impl.cc
  - stub_plugin_impl.h
- - BUILD
  - configuration_test.cc
  - http_dynamic_delay_filter_integration_test.cc
  - http_filter_base_test.cc
  - http_filter_integration_test_base.cc
  - http_filter_integration_test_base.h
  - http_test_server_filter_integration_test.cc
  - http_time_tracking_filter_integration_test.cc
- - BUILD
  - nighthawk_sink_client_test.cc
  - sink_service_test.cc
  - sink_test.cc
  - test_stats_sink_config.proto
- - BUILD
  - environment.h
  - mock_stream.h
  - proto_matchers.h
- - circllhist_proto_json.gold
  - hdr_proto_json.gold
  - output_formatter.csv.gold
  - output_formatter.dotted.gold
  - output_formatter.json.gold
  - output_formatter.medium.fortio-noquirks.gold
  - output_formatter.medium.fortio.gold
  - output_formatter.medium.proto.gold
  - output_formatter.prometheus.gold
  - output_formatter.txt.gold
  - output_formatter.yaml.gold
  - percentile-column-overflow.json
  - percentile-column-overflow.txt.gold
- - BUILD
  - log_response_headers_plugin_test.cc
  - user_defined_output_plugin_creator_test.cc
- benchmark_http_client_test.cc
- BUILD
- client_test.cc
- client_worker_test.cc
- factories_test.cc
- flush_worker_test.cc
- frequency_test.cc
- options_test.cc
- output_collector_test.cc
- output_formatter_test.cc
- output_transform_main_test.cc
- platform_util_test.cc
- process_bootstrap_test.cc
- process_test.cc
- python_test.cc
- rate_limiter_plugin_test.cc
- rate_limiter_test.cc
- request_generator_test.cc
- request_source:llm_request_source_plugin_test
- request_stream_grpc_client_test.cc
- run_nighthawk_bazel_coverage.sh
- sequencer_test.cc
- service_main_test.cc
- service_test.cc
- sni_utility_test.cc
- statistic_test.cc
- stopwatch_test.cc
- stream_decoder_test.cc
- termination_predicate_test.cc
- utility_test.cc
- worker_test.cc
- - BUILD
  - requirements.in
  - requirements.txt
- - config.yaml
- .style.yapf
- BUILD
- check_envoy_includes.py
- check_format.sh
- flake8.py
- format_python_tools.py
- format_python_tools.sh
- gen_compilation_database.py
- nighthawk_envoy_updater.py
- shell_utils.sh
- update_cli_readme_documentation.py
.bazelrc
.bazelversion
.clang-format
.clang-tidy
.gitignore
BUILD
CHANGELOG.md
CONTRIBUTING.md
extensions_build_config.bzl
LICENSE
MAINTAINERS.md
nighthawk.code-workspace
OWNERS.md
PROFILING.md
README.md
RELEASE_PROCEDURE.md
repokitteh.star
WORKSPACE

# Installation Guide

1. Get the code

git clone https://github.com/envoyproxy/nighthawk

Downloads the entire project code from GitHub to your computer.

cd nighthawk

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
Python 3 Python is required to use pip.

sudo apt-get install \

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt install -y lld clang llvm lld lldb

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt install -y clang-{format,tidy,tools} clang-doc clang-examples

Installs directly from the APT package repository (Debian/Ubuntu-based).

pip3 install --user -r tools/base/requirements.txt

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose -f ci/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

python3-pip \

Type this command into your terminal and run it.

python3 -m venv ~/my_nh_venv

Runs the Python script (or module).

pip3 install --user -r tools/base/requirements.txt

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

nighthawk

File Explorer

# Installation Guide

2. Official Install Script

3. Docker

4. Python

Today's picks

Was this content helpful?

Recent Feedback

nighthawk

File Explorer

# Installation Guide

2. Official Install Script

3. Docker

4. Python

Today's picks

Was this content helpful?

Recent Feedback

Download README