Configuring Field Aliasing

Configuration of field aliasing is a three-step configuration process comprising creation of a schema (step 1-3), creation of field alias mapping (step 4-7), and activation of the schema (step 8-10). See Field Aliasing for an overview of the three-step configuration process.

  1. From the Profile icon, go to Organization Settings → under Field aliasing on the side menu click Schemas and field aliasing.

  2. On the Schemas and field aliasing page, click Configure schemas and field aliasing and click + New schema. Provide a name for the new schema and click Next.

  3. In the Define schema fields dialog box, enter some aliases along with a description (aliases are the names to be used as the standard fields in your schema).

    You can add more fields to the schema by clicking + Add field. The maximum allowed number of fields in a schema is 1,000.

  4. Once you are done entering the desired aliases and descriptions, click Confirm: the new schema is now created but empty at this stage.

  5. Now you need to create the mapping. Still in Configure schemas and field aliases, click the new created schema and click +Alias into this schema.

  6. In the appearing New field alias mapping dialog box, enter a name for the field mapping and then click Next.

  7. In the appearing Alias into schema fields dialog box, do the matching by specifying the original field names that correspond to your schema fields. Each alias mapping can have 50 aliases maximum.

    Enable the Keep original field? checkbox if you want to keep the original field in the mapping. Use Select all to keep all original fields in the mapping. If enabled, the original field will still be searchable. If disabled, only the alias can be searched. See Searching with Field Aliasing for more information on the behavior of the Keep original field? checkbox.

    Click Next.

    Refer to Understanding Schema Requirements on how to create consistent schemas with valid mappings.

    Note

    You cannot install a field alias mapping that has no schema, field aliasing must always refer to a schema that you define.

  8. In the appearing Set condition for field aliasing to take effect dialog box, set the conditions: enter tag field names and tag field values in order to set at least one condition for your mapping; for example, you want field aliasing to apply when field #kind is equal to value logs or if field #repo is equal to value github.

    You can add more conditions by clicking + Add condition.

    Click Confirm once you are done entering the desired conditions. The alias mapping is created.

    Set Conditions

    Figure 90. Set Conditions


    Note

    When setting the conditions for a mapping, tag field values do not accept glob patterns for the filtering (humio* for repository names, for instance) — only literal values are allowed.

  9. Now you must activate the new schema. Click the Active schemas page and click Activate schema, then select the relevant schema in the appearing Select schema dialog box and click Next.

  10. Select the scope for the schema — whether you want to:

    • Apply to whole organization — this sets a general rule that would apply the schema to all repositories and views.

    • Apply to a selection of repositories and views — the schema is associated with specific repositories or views that you select from those available; this choice will overwrite the organization level schema for the selected views, if one is applied.

      Click Next.

  11. If you selected the scope Apply to a selection of repositories and views, select the relevant view/repo in the appearing Select view/repo dialog box and click Confirm.

Your schema is now ready and appears in the list of active schemas, meaning that fields that you have aliased (the mapping you have done in step 6) are renamed in the Fields panel (under the Search page) and ready to use at search. See Searching with Field Aliasing for information on how field aliasing works during search.