All Collections
Monitor
Search in the logs screen
Search in the logs screen

Know how to use the payload field and make searches in the logs screen.

Micaella Mazoni avatar
Written by Micaella Mazoni
Updated over a week ago

IMPORTANT: This documentation has been discontinued. Read the updated Pipeline Logs documentation on our new documentation portal.

Rules and storage limit

In some cases, the Platform presents truncated payloads, because the size and exhibition would be too big. To ease the use of this exhibition method, these are the followed rules:

  • Full exhibition of the received payload: the pipeline execution happens normally and the full payload is registered in the log messages when the payload size is smaller than 32kb;

  • Partial exhibition of the received payload: the pipeline execution happens normally and the partial payload is registered in the log messages when the payload size is greater than 32kb and smaller than 320kb. When the payload meets this criteria, a message in yellow is displayed in the Platform;

  • Truncated exhibition of the received payload: the pipeline execution happens normally and the payload is registered in a truncated way (@@DGB_TRUNCATED@@) in the log messages when the payload size is greater than 320kb. When the payload meets this criteria, a message in red is displayed in the Platform.

You must inform a new payload in the manual re-execution moment through the Platform itself, whether the exhibition is partial or truncated.

Searches in the logs screen

To ease your experience in the Platform, we've created a standard in the search of the logs screen.

Check how to use the payload field and make

  • simple searches;

  • fuzzy searches;

  • advanced searches.

PAYLOAD FIELD

In this field, you can use the simple query resource of “elasticsearch”, which allows searches to be made through the syntax of this type of filter. See the examples below:

+

operation AND

|

operation OR

-

denies an unique token

"

involves a series of token to give meaning to a search sentence

*

by the end of a term, it means a prefix query

()

precedence

~ N

after a word, it means editing distance (imprecision)

~ N

after a sentence, it means the amount of distance of these words in the sentence

SIMPLE SEARCHES

The standard operator of the payload field is operator "AND". Therefore, by making a simples search, with the searched words separated by space, the query looks like this:

Payload

test xpto url

The filter will be interpreted the following way:

test AND xpto AND url

If you want to search the exact word, just put it between quotation marks ("").

Payload

"13567559-01"

In this case, the filter searches the specific word.

If you want to search a result from a partial word, just add the asterisk (*):

Payload

request*

In the example above, the search will bring as result any word that starts with the requested prefix.

IMPORTANT: it's not possible to search partial words in the middle of the word due to the fields indexing.

FUZZY SEARCHES

An edit distance is the number of one-character changes needed to turn one term into another. These changes can include:

  • Changing a character (box → fox) ~1

  • Removing a character (black → lack) ~1

  • Inserting a character (sic → sick) ~1

  • Transposing two adjacent characters (act → cat) ~1

To find similar terms, the fuzzy search creates a set of all possible variations or expansions of the search term within a specified edit distance. The query then returns exact matches for each expansion.

Let's say you have these 3 registers:

Register 1: Andrew Joe Clinton

Register 2: Andrew Joe X. Clinton

Register 3: Andrew Joe X. JJ Clinton

And that you make the search in the following way:

Payload

"Andrew Clinton"~1

The only returned register will be Register 1, because between “Joe” and “Clinton” you asked for up to ONE (~1) modification.

If you change your search to

Payload

"Andrew Clinton"~2

the returned registers will be Register 1 and Register 2, because between “Joe” and “Clinton” you asked for up to TWO (~2) modifications.

The fuzzy search can also be used according to the description:

Payload

"cat"~1

So, only close words with only ONE modification (~1) will be found.

Example

CAT, CAB, TAC, ACT, ….

ADVANCED SEARCHES

You can combine many operators in the search.

Payload

xpto +(test | prod) -data

The query will be interpreted the following way:

xpto AND (test OR prod) AND DOES NOT CONTAIN data

As previously mentioned, the standard operator of the search field is the operator "AND":

Payload

(url xpto) (test | flow)

Therefore, the search will be interpreted like this:

(url AND xpto) AND (test OR flow)
Did this answer your question?