@@ -37,26 +37,31 @@ The server will start on `http://localhost:8000` by default.
3737## API Endpoints  
3838
3939### ` /v1/manifest/test_read `  
40+ 
4041Test reading from a specific stream in the manifest.
4142
4243** POST**  - Test stream reading with configurable limits for records, pages, and slices.
4344
4445### ` /v1/manifest/check `  
46+ 
4547Check configuration against a manifest.
4648
4749** POST**  - Validates connector configuration and returns success/failure status with message.
4850
4951### ` /v1/manifest/discover `  
52+ 
5053Discover streams from a manifest.
5154
5255** POST**  - Returns the catalog of available streams from the manifest.
5356
54- ### ` /v1/manifest/resolve `  
57+ ### ` /v1/manifest/resolve `  
58+ 
5559Resolve a manifest to its final configuration.
5660
5761** POST**  - Returns the resolved manifest without dynamic stream generation.
5862
5963### ` /v1/manifest/full_resolve `  
64+ 
6065Fully resolve a manifest including dynamic streams.
6166
6267** POST**  - Generates dynamic streams up to specified limits and includes them in the resolved manifest.
@@ -68,6 +73,7 @@ The manifest server supports custom Python components, but this feature is **dis
6873### Enabling Custom Components  
6974
7075To allow custom Python components in your manifest files, set the environment variable:
76+ 
7177``` bash 
7278export  AIRBYTE_ENABLE_UNSAFE_CODE=true
7379``` 
@@ -77,27 +83,33 @@ export AIRBYTE_ENABLE_UNSAFE_CODE=true
7783The manifest server supports optional JWT bearer token authentication:
7884
7985### Configuration  
86+ 
8087Set the environment variable to enable authentication:
88+ 
8189``` bash 
8290export  AB_JWT_SIGNATURE_SECRET=" your-jwt-secret-key" 
8391``` 
8492
8593### Usage  
94+ 
8695When authentication is enabled, include a valid JWT token in the Authorization header:
96+ 
8797``` bash 
8898curl -H " Authorization: Bearer <your-jwt-token>" 
8999  http://localhost:8000/v1/manifest/test_read
90100``` 
91101
92102### Behavior  
93- -  ** Without ` AB_JWT_SIGNATURE_SECRET ` ** : All requests pass through 
103+ 
104+ -  ** Without ` AB_JWT_SIGNATURE_SECRET ` ** : All requests pass through
94105-  ** With ` AB_JWT_SIGNATURE_SECRET ` ** : Requires valid JWT bearer token using HS256 algorithm
95106
96107## OpenAPI Specification  
97108
98109The manifest server provides an OpenAPI specification for API client generation:
99110
100111### Generating the OpenAPI Spec  
112+ 
101113``` bash 
102114#  Generate OpenAPI YAML (default location)
103115manifest-server generate-openapi
@@ -107,6 +119,7 @@ manifest-server generate-openapi --output /path/to/openapi.yaml
107119``` 
108120
109121The generated OpenAPI specification is consumed by other applications and tools to:
122+ 
110123-  Generate API clients in various programming languages
111124-  Create SDK bindings for the manifest server
112125-  Provide API documentation and validation
@@ -115,6 +128,7 @@ The generated OpenAPI specification is consumed by other applications and tools
115128### Interactive API Documentation  
116129
117130When running, interactive API documentation is available at:
131+ 
118132-  Swagger UI: ` http://localhost:8000/docs ` 
119133-  ReDoc: ` http://localhost:8000/redoc ` 
120134
@@ -139,4 +153,26 @@ docker build -f airbyte_cdk/manifest_server/Dockerfile -t manifest-server .
139153docker run -p 8080:8080 manifest-server
140154``` 
141155
142- Note: The container runs on port 8080 by default.
156+ Note: The container runs on port 8080 by default.
157+ 
158+ ## Datadog APM  
159+ 
160+ The manifest server supports Datadog APM tracing for monitoring and observability:
161+ 
162+ ### Configuration  
163+ 
164+ To enable Datadog tracing, set the environment variable:
165+ 
166+ ``` bash 
167+ export  DD_ENABLED=true
168+ ``` 
169+ 
170+ This requires the ` ddtrace `  dependency, which is included in the ` manifest-server `  extra. For additional configuration options via environment variables, see [ ddtrace configuration] ( https://ddtrace.readthedocs.io/en/stable/configuration.html ) .
171+ 
172+ ### Usage  
173+ 
174+ ``` bash 
175+ #  Run with Datadog tracing enabled
176+ DD_ENABLED=true manifest-server start
177+ ``` 
178+ 
0 commit comments