This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

› › ›

Translate GUID

edit

Translate GUID

edit

The translate_ldap_attribute processor translates an LDAP attributes between eachother. It is typically used to translate AD Global Unique Identifiers (GUID) into their common names.

Every object on an Active Directory or an LDAP server is issued a GUID. Internal processes refer to their GUID’s rather than the object’s name and these values sometimes appear in logs.

If the search attribute is invalid (malformed) or does not map to any object on the domain then this will result in the processor returning an error unless ignore_failure is set.

The result of this operation is an array of values, given that a single attribute can hold multiple values.

Note: the search attribute is expected to map to a single object. If it doesn’t, no error will be returned, but only results of the first entry will be added to the event.

processors:
  - translate_ldap_attribute:
      field: winlog.event_data.ObjectGuid
      ldap_address: "ldap://"
      ldap_base_dn: "dc=example,dc=com"
      ignore_missing: true
      ignore_failure: true

The translate_ldap_attribute processor has the following configuration settings:

Table 5. Translate GUID options

Name	Required	Default	Description
`field`	yes		Source field containing a GUID.
`target_field`	no		Target field for the mapped attribute value. If not set it will be replaced in place.
`ldap_address`	yes		LDAP server address. eg: `ldap://ds.example.com:389`
`ldap_base_dn`	yes		LDAP base DN. eg: `dc=example,dc=com`
`ldap_bind_user`	no		LDAP user.
`ldap_bind_password`	no		LDAP password.
`ldap_search_attribute`	yes	`objectGUID`	LDAP attribute to search by.
`ldap_mapped_attribute`	yes	`cn`	LDAP attribute to map to.
`ldap_search_time_limit`	no	30	LDAP search time limit in seconds.
`ldap_ssl`*	no	30	LDAP TLS/SSL connection settings.
`ignore_missing`	no	false	Ignore errors when the source field is missing.
`ignore_failure`	no	false	Ignore all errors produced by the processor.

* Also see SSL for a full description of the ldap_ssl options.

If the searches are slow or you expect a high amount of different key attributes to be found, consider using a cache processor to speed processing:

processors:
  - cache:
      backend:
        memory:
          id: ldapguids
      get:
        key_field: winlog.event_data.ObjectGuid
        target_field: winlog.common_name
      ignore_missing: true
  - if:
      not:
        - has_fields: winlog.common_name
    then:
      - translate_ldap_attribute:
          field: winlog.event_data.ObjectGuid
          target_field: winlog.common_name
          ldap_address: "ldap://"
          ldap_base_dn: "dc=example,dc=com"
      - cache:
          backend:
            memory:
              id: ldapguids
            capacity: 10000
          put:
            key_field: winlog.event_data.ObjectGuid
            value_field: winlog.common_name

« Timestamp Translate SID »