# Stream

The reference to declaring a stream in any YAML file within the .baselime folder.

.baselime/demo.yml
# Reference (ref) of the stream
random-num-gen-value:
  # Required: Type of resource, must be "stream"
  type: stream

  # Required: The properties of the resource
  properties:
 
    # Name of the stream
    name: demo name

    # Required: stream parameters
    parameters:
      
      # Required: An array of datasets to run the stream against
      datasets: logs
      
      # Optional: The namespaces to filter when running the stream. Default: Will include all available namespaces
      namespaces:
        - demo-lambda

      # Optional: A flag on whether to include or exclude specified namespaces. Default: INCLUDE
      namespaceCombination: INCLUDE # Possible values: INCLUDE, EXCLUDE, STARTS_WITH
      
      # Optional: Filter events based on additional criteria
      # Default: Will not apply any filters on the stream
      filters:
        - "@type = REPORT"
        - "@duration > 10"

      # Optional: If multiple filters are provided, defines how to combine them
      # Default: Will filter only events that match all the criteria specified in filters
      filterCombination: AND # Possible values: AND, OR

      # Optional: A needle is a search object containing an item, isRegex and matchCase booleans.
      needle:
        item: "message" # A string to search for in your events.
        isRegex: false # optional, default: false.
        matchCase: false # optional, default: false. 

# stream filters

Each stream filter is a string that can be represented as <key> <operation> <value>

  • <key>: the event property to filter against.
  • <operation>: an operation used to compare the key against the value. For further details, please check the list of accepted operations.
  • <value>: the value to compare the key against.