All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Exposed
prom-client
usinggetMetricClient
function.
- Upgrade
prom-client
- Improved Next.js parameterized route capturing capability
- Optional
additionalLabels
option. The added label keys will be emitted with all metrics if the label value is set usingsetOpenAPMLabels
. setOpenAPMLabels
function to set custom labels to the metrics emitted by OpenAPM.
- Optional
enableMetricsServer
option to enable or disable the metrics server. - Optional
enabled
option to conditionally enable or disable OpenAPM. - Exposed the
getMetrics
function to get the metrics in prometheus exposition format. - Add support to instrument applications based on the
Next.js
framework in the Node.js environment. - Automatically add Prisma metrics if they are available.
- BREAKING The OpenAPM metrics server will not close automatically when the application shuts down. Call the
shutdown
function explicitly to shut down OpenAPM.
- Skip the
OPTIONS
requests from the instrumentation process.
- The ability to automatically detect the correct
path
labels based on user routes in their applications. This will solve the cardinality blowup of endpoints that are not being folded correctly.
- Optional
customPathsToMask
option to mask certain values as it is no longer needed now. It will be removed in future releases.
- Optional Change Events Support. Track the
application_start
event for Express applications in Levitate along with other APM metrics.
- Add
excludeDefaultLabels
to the options. - Add support to instrument
NestJS
applications.
- Migrate from
Rollup
totsup
for building package.
- Add
extractable
to the options to extract any labels from the URL params, such as a tenant or org name, allowing support for multi-tenant monitoring. - Gracefully shutdown metrics server
- Track the success or failure of database queries with the
status
label in thedb_requests_duration_milliseconds
metric. Supported values -success
andfailure
.
- Auto instrumentation of Rate and Duration metrics for MySQL DB
- Preconfigured Grafana dashboard JSON that can be imported directly
- Auto instrumentation of R.E.D (Rate, Errors & Duration) metrics for Express.js