v1.0.0: Autometrics 1.0 compliance and first-class Deno support
This release features full compliance with the Autometrics v1.0.0 specification as well as first-class Deno support. Also, our decorators have been updated to match the Stage 3 ECMAScript decorators proposal.
Autometrics 1.0.0
In order to match the full Autometrics specification, we implemented the following features and changes:
- Decorators now have support for skipping individual methods when decorating a class. Just decorate the method you wish to exclude with
@Autometrics({ skip: true })
. - We added support for the
service.name
label. The service name is automatically detected based on theAUTOMETRICS_SERVICE_NAME
orOTEL_SERVICE_NAME
environment variables (in order of significance). If neither environment variable is set, Autometrics-ts attempts to determine the service name based on the package name defined inpackage.json
. - We also added support for the
repository.url
andrepository.provider
labels. These labels can be used to create links from Autometrics function metrics directly to your source code. We attempt to auto-detect these labels based on your Git configuration, but you can configure them explicitly using theAUTOMETRICS_REPOSITORY_URL
andAUTOMETRICS_REPOSITORY_PROVIDER
environment variables. - When submitting metrics using OTLP, we now use dots in label names instead of underscores. For instance,
function.name
instead offunction_name
. When used with Prometheus, labels should still be exported using underscores. - Users should see a warning in their console if they've configured an invalid objective name.
Note that all labels such as service.name
and repository.url
/repository.provider
are also configurable in the init()
function, in addition to using environment variables.
Deno support
We already offered experimental Deno support before, but with this release we've taken things one step further: We've migrated the Autometrics-ts core library to be Deno-first! This means we use Deno for our internal development and the Deno library is a first-class citizen. Most of our core unit tests also run in Deno now.
We also publish Deno releases straight to https://deno.land/x/autometrics now. (Please note there is still a slightly awkward lib-
prefix in the version specifiers, which we hope to resolve in the future.)
Improved web compatibility
Thanks to the plumbing we did for moving to a Deno-first approach (shoutout dnt and rollup!), we have also been able to improve our compatibility with web bundlers. We now generate two versions of our NPM packages, one for Node.js users and one for web users. They're both bundled within the same package, so this should be fully transparent to our users.
Modern decorators
Previous versions of Autometrics-ts only supported the TypeScript-specific legacy decorators. We still support those as well, but they've been renamed to @AutometricsLegacy
. The new @Autometrics
decorators are fully compliant with the ECMAScript proposal.
The updated feature set, such as the new @Autometrics({ skip: true })
option, is supported by both our modern and legacy decorators alike.
Detailed CHANGELOG
Here is a more detailed list of changes:
Changed
- BREAKING: Labels are submitted with dots instead of underscores when
exported through OTLP. This should not affect exports to Prometheus. - BREAKING: The
@Autometrics
decorator is now compliant with the
Stage 3 ECMAScript decorators proposal.
For the legacy TypeScript decorators, please use@AutometricsLegacy
instead. - BREAKING: Autometrics 1.0:
caller.function
andcaller.module
have
been changed to match the specification. - Deno has become a first-class supported platform.
Added
- Autometrics 1.0: Added support for the
service.name
label. - Autometrics 1.0: Added support for the
repository.url
and
repository.provider
labels. - Autometrics 1.0: Added support for excluding individual methods from the
class decorator, using@Autometrics({ skip: true })
. This also works with
the legacy decorator. - Autometrics 1.0: Users should see a warning in their console if they've
configured an invalid objective name.
Fixed
- Fixed
this
handling in the wrappers and decorators. - Fixed using the
autometrics
package with web bundlers such as Parcel and
WebPack. - Fixed an issue where caller information sometimes wasn't submitted.