Telemetry

Portway exports request traces and metrics through one provider, selected with Telemetry:Provider. The built-in dashboard is independent of the provider.

Settings → Telemetry edits these settings. A restart applies them. A setting with a set environment variable is read-only in the console.

Choosing a provider ​

Observability platforms (Grafana Alloy, Jaeger, Datadog) use Otlp; a standalone Prometheus server uses Prometheus. An OTLP collector can re-expose metrics to Prometheus, as in the collector example.

Using the OTLP provider ​

{
  "Telemetry": {
    "Provider": "Otlp",
    "ServiceName": "portway-prod",
    "ResourceAttributes": "deployment.environment=production,host.name=gw01",
    "Otlp": {
      "Endpoint": "http://otel-collector.internal:4317"
    }
  }
}

Environment variables:

export PORTWAY_TELEMETRY_PROVIDER=Otlp
export PORTWAY_OTLP_ENDPOINT=http://otel-collector:4317
export PORTWAY_SERVICE_NAME=portway-prod

$env:PORTWAY_TELEMETRY_PROVIDER = "Otlp"
$env:PORTWAY_OTLP_ENDPOINT = "http://otel-collector:4317"
$env:PORTWAY_SERVICE_NAME = "portway-prod"

Using the Prometheus provider ​

{
  "Telemetry": {
    "Provider": "Prometheus",
    "Prometheus": {
      "Path": "/metrics"
    }
  }
}

The scrape path defaults to /metrics. Matching scrape configuration:

scrape_configs:
  - job_name: portway
    scrape_interval: 15s
    static_configs:
      - targets: ["portway.internal:8080"]

The Prometheus provider exports no traces.

What Portway exports ​

Traces (OTLP provider) ​

Errors handled by Portway's exception handler are recorded on the active span with exception.type, exception.message and exception.stacktrace.

Metrics (both providers) ​

The portway.request_source dimension is api for /api calls, ui for console calls and other for the rest. The portway.endpoint dimension contains the configured endpoint name with namespace and version for API calls (e.g. Products, CRM/Accounts, Inventory/Products@v2, composite/SalesOrder) and is empty for other requests and for paths that match no configured endpoint. http.method is OTHER for methods outside GET, POST, PUT, PATCH, DELETE, MERGE, QUERY, HEAD and OPTIONS.

Docker Compose ​

A gateway pushing to a collector that re-exposes metrics to Prometheus and forwards traces to Jaeger:

services:
  portway:
    image: ghcr.io/melosso/portway:latest
    environment:
      PORTWAY_TELEMETRY_PROVIDER: Otlp
      PORTWAY_OTLP_ENDPOINT: http://otel-collector:4317
      PORTWAY_SERVICE_NAME: portway-prod
    ports:
      - "8080:8080"

  otel-collector:
    image: otel/opentelemetry-collector-contrib:latest
    volumes:
      - ./otel-collector.yaml:/etc/otelcol-contrib/config.yaml
    ports:
      - "4317:4317"

# otel-collector.yaml
receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317

exporters:
  prometheus:
    endpoint: 0.0.0.0:8889
  otlp/jaeger:
    endpoint: jaeger:4317
    tls:
      insecure: true

service:
  pipelines:
    traces:
      receivers: [otlp]
      exporters: [otlp/jaeger]
    metrics:
      receivers: [otlp]
      exporters: [prometheus]

With PORTWAY_TELEMETRY_PROVIDER: Prometheus the collector service is not needed; Prometheus scrapes the portway container.

Windows Server and IIS ​

appsettings.Production.json overrides appsettings.json:

{
  "Telemetry": {
    "Provider": "Otlp",
    "Otlp": {
      "Endpoint": "http://otel-collector.internal:4317"
    }
  }
}

Under IIS, <environmentVariables> in web.config override appsettings.json:

<configuration>
  <system.webServer>
    <aspNetCore processPath="dotnet" arguments=".\PortwayApi.dll" stdoutLogEnabled="false">
      <environmentVariables>
        <environmentVariable name="PORTWAY_TELEMETRY_PROVIDER" value="Otlp" />
        <environmentVariable name="PORTWAY_OTLP_ENDPOINT" value="http://otel-collector.internal:4317" />
      </environmentVariables>
    </aspNetCore>
  </system.webServer>
</configuration>

Upgrading from earlier versions ​

Earlier releases used a flat Enabled switch and an OtlpEndpoint key. Both remain supported: "Enabled": true selects the OTLP provider, and OtlpEndpoint is used when Otlp:Endpoint is not set.