Custom Segments
Monitor custom code blocks.
Thanks to Inspector you are able to put everything you want in the transactions timeline getting a real-time feedback about the execution of a code block inside your application.
By default Inspector will report many different tasks based on the application's dependencies, but you are free to "wrap" some parts of your code that you consider relevant to create a more complete picture of what statements are executed during an execution cycle and its performance.
Short form
Just a few lines of code are needed:
1
inspector.addSegment(() => {
2
3
// Your statements here...
4
5
}, 'type', 'label')
Copied!
This will produce a new segment in the timeline:
A new segment in the timeline
As showed in the example above a new segment is built with three input parameters:
Parameter
Required
Description
callback
YES
The code block you want keep under real-time monitoring
type
YES
This is the master category of your segments
label
NO
Human readable label or specific task name that will be showed inside the timeline in your Inspector dashboard. If it isn't provided
type is used as label.Think about how database queries is reported. That's one master category like
mysql but each query has its own custom label that simply is an extract of the sql code executed for a better timeline consultation.- mysql: master type
- select * from table...: label
In this way you can mark toghether the statements related to a specific task using something like
csv-export as type parameter and use the filename as label for each statement of this type.Get return
What you return from your callback will be returned back by
addSegment() method.1
/**
2
* "result " will contains the string "Hello".
3
*
4
* Note the use of "await".
5
*/
6
let result = await inspector.addSegment(() => {
7
8
// Your statements here...
9
10
return 'Hello'
11
12
}, 'csv-export', csvFileName)
Copied!
Working with Promise
inspector.addSegment() return a Promise. If you want wait the execution of the callback you need to use async/await construct or then/catch.1
// Use await
2
await inspector.addSegment(...)
3
​
4
// Use then/catch
5
inspector.addSegment(...)
6
.then()
7
.catch()
Copied!
Add contextual informations
If you need to report some contextual information, the new segment will be injected as callback parameter:
1
/**
2
* "result " will contains the string "Hello"
3
*/
4
let result = await inspector.addSegment(segment => {
5
6
// Your statements here...
7
8
// Attach interesting data
9
segment.addContext('payload', {
10
foo: 'bar'
11
})
12
13
// return a result if needed
14
return 'Hello'
15
16
}, 'csv-export', csvFileName)
Copied!
Some ideas to use custom segments
Here are some scenarios where new segments can help you to anticipate bugs and bottlenecks:
- Http call to external services (webhooks, integration, etc.)
- Functions that deal with files (pdf, excel, images)
- Data manipulation processes (import/export, data aggregation, etc.)
Last modified 1yr ago