Manage Fields Metrics & Groups

Groups

Creating new Group

Best practice: use groups!

When your number of Fields & Metrics raises due to the increasing number of log types its becoming hard to manage and use them. Group is there to mitigate the situation and keep your platform easy to use.

A group is a set of Fields, Tag Sets and Metrics that help users to switch from a context to another.
After clicking on + New Group a popup like this appears:

Creating a new Group pop up

Creating a new Group pop up

In this form you can:

  • Name: assign a name
  • Description: give a short description of the group
  • Icon: attach a corresponding icon over a list of 400+ at disposal (optional)
  • Color: assign a color (optional)

Once the group is created, you can then attach any Field, Tag Set or Metric to it.

Here is an example of a platform well configured for multiple usages:

Filtering Fields, Tag Sets, Metrics and Calculated Metrics with their associated groups

Filtering Fields, Tag Sets, Metrics and Calculated Metrics with their associated groups

Sorting fields & metrics

By default, fields & metrics contained in a group are sorted alphabetically. However, when editing one you have the ability to re-order them. This order is used everywhere in the exploration view or in any places we expose lists of fields or metrics.

Re-order fields in the Java group

Re-order fields in the Java group

Fields

Creating a new field

Classic field edition

As an admin you can create a new Field directly from any raw log.

Adding a field from the raw log view

Adding a field from the raw log view

The other option to create a new fields is to go to the end of the field list on the Field & Metrics panel and click on +New Field. A popup like this should appear:

Create a new field

Create a new field

In this form you can:

  • Attribute: pick a field over the list of identified ones - custom.@version in our example
  • Name: provide a friendly name
  • Icon: attach a corresponding icon over a list of 400+ at disposal (optional)
  • Format: pick a desired format over None, Capitalize, Uppercase and Lowercase (optional)
  • Groups: attach this field to one or several groups (optional)

More option for field edition

If you click on the More button two new fields will appear:

With this new form you can:

  • Identifier: change the identifier of your field for Logmatic.io
  • Description: add a description (optional)

Modifying an identifier can break things

Be careful, if you change this value you can break all analyses, alerts, dashboards and API calls that depend on it.

Customize Values for a given field

This feature allows you to change the display name and color of any value of a field. This is particularly useful for instance to transform identifiers (eg "412321") in labels (eg "mycustomer").

To do so, simply click on customize values at the bottom of the field form then enter the values you want to customize.

Replacing the display of "fr" value by "France"

Replacing the display of "fr" value by "France"

Only original values are understood by search bars

Please be aware that you won't be able to search values directly from their display names and only by their original values.

Metrics

Creating a numerical metric

As an admin you can create a new Metric directly from any raw log.

Add a metric from the raw log view

Add a metric from the raw log view

The other option to create a new metric is to go to the end of the metric list on Field & Metrics panel and click on +New Metric. A popup like this should appear:

Creating a new metric pop up

Creating a new metric pop up

In this form you can:

  • Attribute: pick a numerical field over the list of identified ones - Even Date in our example
  • Computation: pick an aggregation function over Max, Min, Avg and Sum - Max in our example
  • Name: provide a friendly name
  • Icon: attach the corresponding icon over a list of 400+ at disposal (optional)
  • Format: pick a desired format over Number, Percentage,Bytes, Duration or Timestamp. For the last 2, durations and timestamps must be expressed in milliseconds.
  • Groups: attach this metric to one or several groups (optional)

Creating a Unique Value Count metric

You can also create special metrics that count the number of distinct values for field in any combination you'll get in the analysis view. This is really useful, for instance, to see how many distinct users connect over different periods of time, how many distinct errors occur, etc...

Unique value metric

Unique value metric

For the sake of performance

Unique quantities are exactly computed if the buckets have less than 100 distinct values. After that, you can get an error up to 5%.


What's next ?

Learn how to create Tags & Tag-set to enrich your logs

Manage tags and Tag sets
Calculated Metrics: Formulas & Filtered metrics

Manage Fields Metrics & Groups


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.