Developer’s Guide — Apache Traffic Server documentation

Developer’s Guide — Apache Traffic Server documentation
Developer’s Guide
View page source
Developer’s Guide
This documentation is a work in progress. It was originally written for
a previous, commercially-available version of Traffic Server that
supported different operating systems and more functions than the
current version. As a result, some of the sections may refer to
functionality that no longer exists.
If you find any such issues, you may want to submit a
bug or a
patch
We also have a Wiki page explaining how to
create useful bug reports
We encourage everyone to file tickets, early and often. Looking for existing,
duplicate bugs is encouraged, but not required.
Introduction
Release Process
Requirements
Release Candidate
Document
Build
Distribute
Official Release
Prepare for the next minor release
Contributing to Traffic Server
Debugging and Analysis
Debug Builds
SystemTap and DTrace support
Using TSAssert
Debug Tags
Core Dump Analysis
Profiling
Memory Leaks
Tracing
Threads and Event Processing
Threads
Types
Cache Architecture
Cache Architecture
Cache Initialization
Core Cache
Data Structures
API functions
Topics to be done
Cache Consistency
Volume Tagging
RAM Cache
Cache Tool
Tiered Storage
Logging Architecture
A gentle introduction to ATS logging internals
Internal libraries
ArgParser
MemArena
MemSpan
TextView
BufferWriter
TS.Scalar
Plugin Development
Plugin Development Introduction
Getting Started
Building Plugins
Plugin Configuration
Plugin Management
Actions
Hooks and Transactions
Continuations
Mutexes
IO
HTTP Headers
HTTP Transformations
Remap Plugins
New Protocol Plugins
Plugin Interfaces
Adding Statistics
Example Plugins
Cripts
Overview
Cripts for global plugin
Variables
Urls
Headers
Connections
Certificates
Crypto
Matchers
Miscellaneous
Bundles
Convenience APIs
Examples
Configuration Variable Implementation
Defining the Variable
Variable Infrastructure
Configuration Reload Framework
Overview
Registration API
ConfigContext API
Terminal State Rule
ConfigSource
ConfigType
Adding a New Config Module
Composite Configs
Startup vs. Reload
Thread Model
Naming Conventions
What NOT to Register
Logging Best Practices
Testing
Configuration Records
API Reference
API Types
API Functions
Continuous Integration
Documentation
Conventions
Structure
Building the Documentation
reStructuredText and Sphinx
Traffic Server Specific Markup
Creating New Domains
Documenting Plugins
Host Resolution Proposal
Introduction
Goals
Basics
Required Resolvers
Configuration
Examples
Issues
An Overview Client Sessions and Transactions
Classes
Session Object Relationships
Transaction and Session Shutdown
Core Architecture
Header Heap
HostDB
URL Rewrite Architecture
Design Documents
Reloading Plugins
Layout
Runroot
Testing Traffic Server
Writing Autests
JSONRPC
Architecture
API
JSONRPC Endpoint
JSON RPC errors
Handler implementation
Traffic Server JSONRPC Node C++ Client Implementation
Traffic Control Development Guide
API Handler error codes
Apache Traffic Server
v: 11.0.0
Languages
Versions