Custom Instrumentation

Considerations

In Odigos open source, Custom Instrumentation is supported for PHP applications using the community native OpenTelemetry distro. Custom eBPF-based instrumentations for Go and Java require Odigos Enterprise. PHP probes are delivered as environment variables and require a pod restart to take effect.

Configuration Options

PHP

className

className string - The fully qualified class name to instrument. Leave empty for a global function. - This field is optional

functionName

functionName string - The name of the function or method to instrument. - This field is required

Basic Example

The following example instruments the processOrder method on App\Service\OrderService.

Create a YAML file named custom-instrumentation.yaml with the following content:

apiVersion: odigos.io/v1alpha1
kind: InstrumentationRule
metadata:
    name: custom-instrumentation-rule
    namespace: odigos-system
spec:
    ruleName: "Custom Instrumentation for processOrder"
    customInstrumentations:
        php:
          - className: "App\\Service\\OrderService"
            functionName: "processOrder"

Apply the rule to the cluster:

kubectl apply -f custom-instrumentation.yaml

Restart the PHP workload so the new ODIGOS_PHP_AGENT_CUSTOM_INSTRUMENTATIONS environment variable is picked up.

Getting Started

Instrumentations

Odigos Pipeline

Destinations

Concepts

Contribution Guidelines

Custom Instrumentation

Considerations

Configuration Options

Basic Example

​Considerations

​Configuration Options

​Basic Example

Considerations

Configuration Options

Basic Example