# Reference

[Site index](https://docs.speedscale.com/llms.txt)

## Pages

- [Control Speedscale via API](https://docs.speedscale.com/reference/api-first/index.md): Control Speedscale programmatically via API for seamless data collection and traffic replay, ensuring consistent capabilities across UI and API-driven usage.
- [Deployment Architecture](https://docs.speedscale.com/reference/architecture/index.md): Explore the deployment architecture of Speedscale, detailing components, network requirements, and installation methods for Kubernetes environments.
- [HTTP Headers](https://docs.speedscale.com/reference/configuration/assertions/assert-http-headers/index.md): Learn how to configure HTTP header assertions in Speedscale to validate the presence of specific headers in your API responses. This documentation provides detailed guidelines and examples to effectively implement and utilize these assertions for improved API performance and reliability.
- [Chaos Fired](https://docs.speedscale.com/reference/configuration/assertions/chaosfired/index.md): Fail a replay when a chaos rule perturbs more or fewer responses than configured, or a required rule never matches any traffic.
- [HTTP Output](https://docs.speedscale.com/reference/configuration/assertions/httpoutput/index.md): Fail a replay when the outbound HTTP calls an app makes to its mocked dependencies differ from the recording: missing, unexpected or repeated calls, changed arguments, and hosts that were not mocked.
- [HTTP Response Body](https://docs.speedscale.com/reference/configuration/assertions/httpresponsebody/index.md): Validate HTTP response bodies with Speedscale by comparing runtime values to expected results, including support for JSON and gRPC content types.
- [HTTP Cookies](https://docs.speedscale.com/reference/configuration/assertions/httpresponsecookies/index.md): Learn how to configure HTTP response cookies in Speedscale by utilizing various assertion options to enhance testing accuracy. This comprehensive guide provides essential details on cookie attributes, enabling developers to validate response behaviors effectively.
- [HTTP Response Schema](https://docs.speedscale.com/reference/configuration/assertions/httpresponseschema/index.md): Compare HTTP response schemas with Speedscale to identify differences in runtime and expected bodies, including support for JSON and gRPC content types.
- [HTTP Status Code](https://docs.speedscale.com/reference/configuration/assertions/httpstatuscode/index.md): Check HTTP status codes in your API responses with Speedscale to ensure they match expected values for accurate testing and validation.
- [Assertions](https://docs.speedscale.com/reference/configuration/assertions/index.md): Explore how to use assertions in Speedscale to compare application responses during testing with recorded traffic for accurate results.
- [Browser](https://docs.speedscale.com/reference/configuration/browser/index.md): Reference for the generator.browser section of a Speedscale test config, which runs Playwright browser journeys instead of recorded requests: journeys, base URL, workers, proxy and responder settings, blocked URLs, timeout, storage state and tokens.
- [Cluster](https://docs.speedscale.com/reference/configuration/cluster/index.md): Configure infrastructure settings for Speedscale by adjusting log levels, build tags, and resource limits to optimize performance during API testing.
- [Endpoint and session load-plan reference](https://docs.speedscale.com/reference/configuration/endpoint-load-plans/index.md): JSON fields, scheduling units, selection ownership and failure semantics for grouped replay load.
- [Goals](https://docs.speedscale.com/reference/configuration/goals/index.md): Define success criteria for your tests with Speedscale by setting goals that trigger report failures to ensure optimal performance in CI/CD pipelines
- [Test Config](https://docs.speedscale.com/reference/configuration/index.md): Customize how the replay is performed.
- [Load Pattern](https://docs.speedscale.com/reference/configuration/load-pattern/index.md): Define custom load patterns in Speedscale to shape traffic replay, including ramping requests per second and maintaining desired throughput.
- [Traffic](https://docs.speedscale.com/reference/configuration/traffic/index.md): Configure traffic settings in Speedscale to customize URL transformations and group API endpoints for efficient traffic replay and testing
- [Data Retention](https://docs.speedscale.com/reference/data-retention/index.md): Understand Speedscale's data retention policies, including tiered storage options and access methods for Traffic Viewer and long-term data management.
- [eBPF Traffic Collection](https://docs.speedscale.com/reference/ebpf-traffic-collection/index.md): Explore how Speedscale utilizes eBPF for efficient traffic collection in Kubernetes, capturing plaintext and TLS traffic without application changes.
- [Collector Resource Utilization](https://docs.speedscale.com/reference/ebpf-traffic-collection/resource-utilization/index.md): Analyze Collector Resource Utilization in Speedscale to optimize Kubernetes DaemonSet performance and plan for capacity based on observed resource usage metrics.
- [Workload Impact](https://docs.speedscale.com/reference/ebpf-traffic-collection/workload-impact/index.md): Understand how Speedscale's eBPF collector affects captured applications, including latency, CPU attribution, progressive delivery, and failure behavior.
- [FAQ](https://docs.speedscale.com/reference/faq/index.md): Explore the Speedscale FAQ page to find answers about environment compatibility, missing metrics, and troubleshooting pod startup issues for API testing.
- [Complex Example](https://docs.speedscale.com/reference/filters/complex-example/index.md): Explore the Complex Example page to understand how Speedscale's default Forwarder configuration combines multiple filter rules for effective traffic management
- [Filters](https://docs.speedscale.com/reference/filters/index.md): Utilize filters in Speedscale to refine traffic collection, isolate snapshots, and tailor assertions for effective API testing and mocking solutions
- [Simple Example](https://docs.speedscale.com/reference/filters/simple-example/index.md): Configure filters in Speedscale to exclude monitoring calls from AWS ELB and Prometheus for effective traffic replay and API testing.
- [Structure](https://docs.speedscale.com/reference/filters/structure/index.md): Understand the structure of filter rule sets in Speedscale, including conditions, criteria, and operators for effective API testing and traffic replay.
- [Generator Sizing Guide](https://docs.speedscale.com/reference/generator-sizing-guide/index.md): Optimize your load testing with the Speedscale Generator Sizing Guide, detailing CPU requirements and factors affecting generator throughput for effective performance.
- [Glossary](https://docs.speedscale.com/reference/glossary/index.md): Explore the Speedscale glossary to understand key terms like Action File, Collector, and Generator related to API testing and traffic replay.
- [Helm Values](https://docs.speedscale.com/reference/helm/index.md): Configure the Speedscale Operator Helm chart with this guide, detailing options for traffic capture, isolation tests, and Kubernetes deployment settings.
- [Java agent and framework support](https://docs.speedscale.com/reference/java/agent/index.md): Enable the Speedscale Java agent in Kubernetes and check tested Java, HTTP client, and Netty capture compatibility.
- [Java TLS trust](https://docs.speedscale.com/reference/java/tls/index.md): Configure Java truststores for Speedscale capture and replay in Kubernetes, on a workstation, and in CI.
- [Kubernetes Annotations](https://docs.speedscale.com/reference/kubernetes-annotations/index.md): Explore Kubernetes annotations for the Speedscale sidecar, including common and sidecar-specific annotations to control traffic replay with Custom Resource Definitions
- [C++](https://docs.speedscale.com/reference/languages/cpp/index.md): C++ guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow.
- [.NET](https://docs.speedscale.com/reference/languages/dotnet/index.md): .NET guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow.
- [Go](https://docs.speedscale.com/reference/languages/golang/index.md): Go guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow.
- [Java](https://docs.speedscale.com/reference/languages/java/index.md): Choose Java capture, TLS trust, and proxy settings for Kubernetes, desktop development, and CI.
- [Kotlin](https://docs.speedscale.com/reference/languages/kotlin/index.md): Kotlin guidance for Speedscale and proxymock, including JVM agent capture, proxy setup, TLS trust, and a first-success workflow.
- [Node.js](https://docs.speedscale.com/reference/languages/nodejs/index.md): Node.js guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow.
- [PHP](https://docs.speedscale.com/reference/languages/php/index.md): PHP guidance for Speedscale and proxymock, including eBPF support, proxy setup, TLS trust, and a first-success workflow.
- [Python](https://docs.speedscale.com/reference/languages/python/index.md): Python guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow.
- [Ruby](https://docs.speedscale.com/reference/languages/ruby/index.md): Ruby guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow.
- [Rust](https://docs.speedscale.com/reference/languages/rust/index.md): Rust guidance for Speedscale and proxymock, including rustls eBPF support, binary requirements, proxy setup, TLS trust, and a first-success workflow.
- [OpenSource Licenses and Credits](https://docs.speedscale.com/reference/licenses/index.md): Explore the open source licenses and credits for Speedscale components, detailing various libraries and their respective licenses for your development needs
- [Networking Requirements](https://docs.speedscale.com/reference/networking/index.md): Understand the networking requirements for Speedscale, including webhook access and traffic configurations necessary for optimal operation in Kubernetes environments.
- [Pricing FAQ](https://docs.speedscale.com/reference/pricing-faq/index.md): Explore Speedscale's Pricing FAQ to understand usage-based billing, data ingestion metrics, and strategies to optimize costs for your API testing needs
- [Proxy Configuration](https://docs.speedscale.com/reference/proxy_config/index.md): Configure Kerberos authentication for Speedscale Cloud proxies and application proxy settings for traffic capture.
- [proxymock CLI reference](https://docs.speedscale.com/reference/proxymock-cli-reference/index.md): proxymock CLI commands, flags, and examples for recording, mocking, replaying, and working with local files, Kubernetes clusters, and Speedscale Cloud.
- [Release Notes](https://docs.speedscale.com/reference/release-notes/index.md)
- [Custom Resource Definition](https://docs.speedscale.com/reference/replay-crd/index.md): Explore the Custom Resource Definition for Speedscale to enable traffic replay in Kubernetes, allowing API traffic testing and validation against workloads.
- [Replay Data Model](https://docs.speedscale.com/reference/replay_data_model/index.md): Explore the Replay Data Model in Speedscale, detailing snapshot creation, raw traffic components, traffic transforms, and report generation for effective API testing.
- [Responder Sizing Guide](https://docs.speedscale.com/reference/responder-sizing-guide/index.md): Optimize your responder mock server's performance with Speedscale's Responder Sizing Guide, detailing environmental requirements and throughput factors for high load scenarios.
- [How Smart Mock Works](https://docs.speedscale.com/reference/smart-mock/index.md): Understand how Smart Mock's AI agent automatically optimizes transform chains through iterative experimentation to achieve high-quality API mocks.
- [Technology Support](https://docs.speedscale.com/reference/technology-support/index.md): Explore Speedscale's technology support for API testing, covering protocol and language support for seamless capture, analysis, and replay.