{"id":43492220,"url":"https://github.com/crossplane/inspector-sidecar","last_synced_at":"2026-02-03T10:14:34.638Z","repository":{"id":334045868,"uuid":"1139171729","full_name":"crossplane/inspector-sidecar","owner":"crossplane","description":null,"archived":false,"fork":false,"pushed_at":"2026-01-30T11:57:54.000Z","size":32,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-31T04:09:19.391Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crossplane.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-21T16:04:59.000Z","updated_at":"2026-01-30T11:30:39.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/crossplane/inspector-sidecar","commit_stats":null,"previous_names":["crossplane/inspector-sidecar"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/crossplane/inspector-sidecar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crossplane%2Finspector-sidecar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crossplane%2Finspector-sidecar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crossplane%2Finspector-sidecar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crossplane%2Finspector-sidecar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crossplane","download_url":"https://codeload.github.com/crossplane/inspector-sidecar/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crossplane%2Finspector-sidecar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29041055,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T10:09:22.136Z","status":"ssl_error","status_checked_at":"2026-02-03T10:09:16.814Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-03T10:14:32.248Z","updated_at":"2026-02-03T10:14:34.633Z","avatar_url":"https://github.com/crossplane.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pipeline Inspector Sidecar\n\nA minimal reference implementation of a sidecar container for Crossplane that captures\nfunction pipeline execution data (requests and responses) and logs them to stdout.\n\nThe full design of this feature can be found in the [design doc](https://github.com/crossplane/crossplane/blob/main/design/one-pager-pipeline-inspector.md).\n\n## Features\n\n- Captures `RunFunctionRequest` and `RunFunctionResponse` data for each function invocation\n- Supports JSON and human-readable text output formats\n- Correlates pipeline steps using trace IDs, span IDs, and step indices\n- Runs as a non-root user in a minimal distroless container\n\n## CLI Flags\n\n| Flag | Environment Variable | Default | Description |\n|------|---------------------|---------|-------------|\n| `--socket-path` | `PIPELINE_INSPECTOR_SOCKET` | `/var/run/pipeline-inspector/socket` | Unix socket path to listen on |\n| `--format` | - | `json` | Output format (`json` or `text`) |\n| `--max-recv-msg-size` | `MAX_RECV_MSG_SIZE` | `4194304` (4MB) | Maximum gRPC receive message size in bytes |\n| `--shutdown-timeout` | `SHUTDOWN_TIMEOUT` | `5s` | Graceful shutdown timeout |\n\n## Usage\n\nThis repository publishes release images to\n`xpkg.crossplane.io/crossplane/inspector-sidecar`. This image can be\nincluded as a sidecar container for Crossplane through the Helm chart's values.\n\n```yaml\n# Example:\n# helm upgrade --install crossplane crossplane/crossplane \\\n#   -n crossplane-system --create-namespace \\\n#   -f pipeline-inspector-values.yaml\n\nargs:\n  - --enable-pipeline-inspector\n  - --pipeline-inspector-socket=/var/run/pipeline-inspector/socket\n\nextraVolumesCrossplane:\n  - name: pipeline-inspector-socket\n    emptyDir: {}\n\nextraVolumeMountsCrossplane:\n  - name: pipeline-inspector-socket\n    mountPath: /var/run/pipeline-inspector\n\nsidecarsCrossplane:\n  - name: pipeline-inspector\n    image: xpkg.crossplane.io/crossplane/inspector-sidecar:latest\n    args:\n      - --format=json\n      # Increase if your function payloads exceed 4MB\n      # - --max-recv-msg-size=8388608\n    volumeMounts:\n      - name: pipeline-inspector-socket\n        mountPath: /var/run/pipeline-inspector\n    resources:\n      requests:\n        cpu: 10m\n        memory: 64Mi\n      limits:\n        cpu: 100m\n        memory: 128Mi\n```\n\n## Output Formats\n\n### JSON Format (default)\n\nThe meta field contains either `compositionMeta` (for XR reconciliation) or `operationMeta` (for standalone operations):\n\n```json\n{\"meta\":{\"compositionMeta\":{\"compositeResourceApiVersion\":\"example.org/v1\",\"compositeResourceKind\":\"XDatabase\",\"compositeResourceName\":\"my-db\",\"compositeResourceNamespace\":\"default\",\"compositeResourceUid\":\"abc-123\",\"compositionName\":\"my-composition\"},\"functionName\":\"function-patch-and-transform\",\"iteration\":0,\"spanId\":\"span-456\",\"stepIndex\":0,\"timestamp\":\"2026-01-15T10:30:00Z\",\"traceId\":\"trace-789\"},\"payload\":{...},\"type\":\"REQUEST\"}\n```\n\n```json\n{\"meta\":{\"operationMeta\":{\"operationName\":\"reconcile\",\"operationUid\":\"op-uid-123\"},\"functionName\":\"function-patch-and-transform\",\"iteration\":0,\"spanId\":\"span-456\",\"stepIndex\":0,\"timestamp\":\"2026-01-15T10:30:00Z\",\"traceId\":\"trace-789\"},\"payload\":{...},\"type\":\"REQUEST\"}\n```\n\n### Text Format\n\nUse `--format=text` for human-readable output. The output adapts based on the context type:\n\n#### Composition Context (XR reconciliation)\n\n```\n=== REQUEST ===\n  XR:          example.org/v1/XDatabase (my-db)\n  XR UID:      abc-123\n  XR NS:       default\n  Composition: my-composition\n  Step:        my-step (index 0, iteration 0)\n  Function:    function-patch-and-transform\n  Trace ID:    trace-789\n  Span ID:     span-456\n  Timestamp:   2026-01-15T10:30:00.000Z\n  Payload:\n    apiVersion: apiextensions.crossplane.io/v1\n    ...\n```\n\n#### Operation Context (standalone operations)\n\n```\n=== REQUEST ===\n  Operation:   reconcile\n  Op UID:      op-uid-123\n  Step:        my-step (index 0, iteration 0)\n  Function:    function-patch-and-transform\n  Trace ID:    trace-789\n  Span ID:     span-456\n  Timestamp:   2026-01-15T10:30:00.000Z\n  Payload:\n    ...\n```\n\n## Building\n\n```bash\n# Build locally\ngo build -o inspector-sidecar .\n\n# Build Docker image\ndocker build -t inspector-sidecar .\n```\n\n## Testing\n\n```bash\ngo test ./...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrossplane%2Finspector-sidecar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrossplane%2Finspector-sidecar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrossplane%2Finspector-sidecar/lists"}