@@ -229,6 +229,78 @@ docker pull ghcr.io/apeirora/opentelemetry-collector-contrib/otelcontribcol-audi
229229docker pull ghcr.io/apeirora/opentelemetry-collector-contrib/otelcontribcol-auditlog:latest
230230` ` `
231231
232+ # # Running the Docker Image
233+
234+ # ## Basic Run Command
235+
236+ ` ` ` bash
237+ # Run with basic configuration
238+ docker run -d \
239+ --name otel-collector-auditlog \
240+ -p 8080:8080 \
241+ -p 4317:4317 \
242+ -p 4318:4318 \
243+ -v "${PWD}/storage:/var/lib/otelcol/storage" \
244+ "ghcr.io/apeirora/opentelemetry-collector-contrib/otelcontribcol-auditlog:auditlogreceiver"
245+ ` ` `
246+
247+ # ## Run with Custom Configuration
248+
249+ ` ` ` bash
250+ # Run with custom config file
251+ docker run -d \
252+ --name otel-collector-auditlog \
253+ -p 8080:8080 \
254+ -p 4317:4317 \
255+ -p 4318:4318 \
256+ -v "${PWD}/storage:/var/lib/otelcol/storage" \
257+ -v "${PWD}/custom-config.yaml:/etc/otel/config.yaml" \
258+ "ghcr.io/apeirora/opentelemetry-collector-contrib/otelcontribcol-auditlog:auditlogreceiver"
259+ ` ` `
260+
261+ # ## Container Management Commands
262+
263+ ` ` ` bash
264+ # Check if container is running
265+ docker ps
266+
267+ # View container logs
268+ docker logs otel-collector-auditlog
269+
270+ # Follow logs in real-time
271+ docker logs -f otel-collector-auditlog
272+
273+ # Stop the container
274+ docker stop otel-collector-auditlog
275+
276+ # Start the container
277+ docker start otel-collector-auditlog
278+
279+ # Restart the container
280+ docker restart otel-collector-auditlog
281+
282+ # Remove the container
283+ docker rm otel-collector-auditlog
284+
285+ # Remove the container and its volumes
286+ docker rm -v otel-collector-auditlog
287+ ` ` `
288+
289+ # ## Test the Running Container
290+
291+ ` ` ` bash
292+ # Test with PowerShell
293+ Invoke-WebRequest -Uri "http://localhost:8080/v1/logs" -Method POST -ContentType "application/json" -Body '{"message": "Test audit log", "timestamp": "2024-01-01T00:00:00Z"}'
294+
295+ # Test with curl
296+ curl -X POST http://localhost:8080/v1/logs \
297+ -H "Content-Type: application/json" \
298+ -d '{"message": "Test audit log", "timestamp": "2024-01-01T00:00:00Z"}'
299+
300+ # Check container health
301+ docker inspect otel-collector-auditlog --format='{{.State.Health.Status}}'
302+ ` ` `
303+
232304# # Development
233305
234306# ## Local Development
@@ -318,6 +390,5 @@ docker inspect otel-collector-auditlog
318390
319391## TODO
320392
321- - **Circuit Breaker**: ✅ Implemented circuit breaker for retry operations
322393- **Logging Improvements**: Fix logging of processed logs (count only valid ones)
323394- **Persistence Queue Analysis**: Investigate how persistence queue in exporters may affect the amount of logs delivered and overall flow
0 commit comments