Flow Example

In this example, the flow captures HTTP transaction logs for a specific API endpoint and exports them using the configured File Exporter.

Example Configuration

/etc/lunar-proxy/flows/flow.yaml

name: HARMetricsExporterFlow

filter:
  url: "api.com/resource/{id}"

processors:
  HARCollector:
    processor: HARMetricsCollector
    parameters:
      - key: exporter_id
        value: file_exporter_01
      - key: transaction_max_size
        value: 5000
      - key: obfuscate_enabled
        value: true
      - key: obfuscate_exclusions
        value:
          query_params: ["id"]
          request_body_paths: ["user.name"]

flow:
  request:
    - from:
        stream:
          name: globalStream
          at: start
      to:
        processor:
          name: HARCollector

  response:
    - from:
        processor:
          name: HARCollector
      to:
        stream:
          name: globalStream
          at: end

Flow Parameters (flow.yaml)

Parameter	Description	Type	Mandatory/Optional	Example Value
name	The name of the flow for identification purposes.	String	Mandatory	HARMetricsExporterFlow
filter.url	The URL pattern to apply the flow to specific API endpoints.	String	Mandatory	api.com/resource/{id}
processors.HARCollector.processor	Defines the processor used for HAR data collection.	String	Mandatory	HARMetricsCollector
processors.HARCollector.parameters.key	Key for specifying processor parameters.	String	Mandatory	exporter_id
processors.HARCollector.parameters.value	Value of the specified parameter for the processor.	String	Mandatory	file_exporter_01
transaction_max_size	Maximum size (in bytes) for each HTTP transaction to be logged.	Integer	Optional	5000
obfuscate_enabled	Enables or disables obfuscation of sensitive data in the logs.	Boolean	Optional	true
obfuscate_exclusions.query_params	List of query parameters to exclude from obfuscation.	Array	Optional	["id"]
obfuscate_exclusions.request_body_paths	List of paths in the request body to exclude from obfuscation.	Array	Optional	["user.name"]