{ "openapi": "3.0.1", "info": { "title": "OpenTelemetry Collector Config Optimizer", "description": "Analyse OpenTelemetry Collector YAML for missing memory limiters, bad processor ordering, batching/retry/queue misconfiguration, high-cardinality and cost risks — and get an optimized configuration back.", "version": "0.1", "x-build-id": "EXhKTlhS4L0GkLobW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/michiganpublictech~otel-config-optimizer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-michiganpublictech-otel-config-optimizer", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/michiganpublictech~otel-config-optimizer/runs": { "post": { "operationId": "runs-sync-michiganpublictech-otel-config-optimizer", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/michiganpublictech~otel-config-optimizer/run-sync": { "post": { "operationId": "run-sync-michiganpublictech-otel-config-optimizer", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "configYaml": { "title": "Collector configuration (YAML)", "type": "string", "description": "The full contents of your Collector config file (e.g. otel-collector.yaml). Use ${env:VAR} references for secrets — any hard-coded credentials are reported (redacted) and replaced by env-var placeholders in the optimized configuration." }, "configUrls": { "title": "Configuration URLs", "type": "array", "description": "Public http(s) URLs of Collector YAML files. GitHub 'blob' links are converted to raw.githubusercontent.com automatically. Private/internal addresses are refused.", "items": { "type": "string" } }, "distribution": { "title": "Collector distribution", "enum": [ "contrib", "core", "k8s" ], "type": "string", "description": "Which Collector build runs this configuration. Components that are not shipped in the selected distribution are reported.", "default": "contrib" }, "optimize": { "title": "Generate optimized configuration", "type": "boolean", "description": "Produce a rewritten configuration with safe fixes (memory_limiter, batch, processor order, queue/retry, logging→debug, secrets→env vars). Charged as a separate 'optimized-config' event only when at least one change is applied.", "default": true }, "minSeverity": { "title": "Minimum severity to report", "enum": [ "info", "low", "medium", "high", "critical" ], "type": "string", "description": "Hide findings below this severity from the output. The score always considers every finding.", "default": "info" }, "failOnSeverity": { "title": "Fail run at severity", "enum": [ "none", "critical", "high", "medium", "low" ], "type": "string", "description": "Fail the run (non-zero exit, useful in CI) when any finding is at or above this severity.", "default": "none" }, "disabledRules": { "title": "Disabled rules", "type": "array", "description": "Rule IDs to skip, e.g. OTEL-QUEUE-004. Requires a plan with the custom rules feature.", "items": { "type": "string" } }, "licenseKey": { "title": "License key", "type": "string", "description": "Optional enterprise or prepaid license key. Leave empty to pay per event on Apify." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }