autometrics-ts

What's Changed

• Change publish command by @arendjr in https://github.com/autometrics-dev/autometrics-ts/pull/148
• fix an infinite loop which happens when autometrics is initialized in a node service without a git repository by @benjibuiltit in https://github.com/autometrics-dev/autometrics-ts/pull/149
• make getModulePath ignore reflect metadata module by @benjibuiltit in https://github.com/autometrics-dev/autometrics-ts/pull/150
• Prepare release 1.0.1 by @brettimus in https://github.com/autometrics-dev/autometrics-ts/pull/151

New Contributors

• @benjibuiltit made their first contribution in https://github.com/autometrics-dev/autometrics-ts/pull/149

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/lib-v1.0.0...lib-v1.0.1

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 the AUTOMETRICS_SERVICE_NAME or OTEL_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 in package.json.
• We also added support for the repository.url and repository.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 the AUTOMETRICS_REPOSITORY_URL and AUTOMETRICS_REPOSITORY_PROVIDER environment variables.
• When submitting metrics using OTLP, we now use dots in label names instead of underscores. For instance, function.name instead of function_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 and caller.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.

Breaking changes: Exporter packages

v0.7 is a big change to how the Autometrics library works in JavaScript. The core library interface of wrappers and decorators remains the same and will collect the metrics as previously, however it will not export them. For that purpose exporters are now separate to the library itself allowing the user more control as to how they want to set up the metrics collection: as a pull endpoint for Prometheus, push gateway, OpenTelemetry collector or something else.

See the changelog for a full list of updates and the updated quickstart on how to work with the new TypeScript packages: https://docs.autometrics.dev/typescript/quickstart

Changelog

• Eagerly push metrics when pushInterval is 0 by @brettimus in https://github.com/autometrics-dev/autometrics-ts/pull/99
• Initial Gravel Gateway Support by @brettimus in https://github.com/autometrics-dev/autometrics-ts/pull/110
• Exporter packages by @arendjr in https://github.com/autometrics-dev/autometrics-ts/pull/115
• Drop on-demand-metric-reader package by @arendjr in https://github.com/autometrics-dev/autometrics-ts/pull/117
• Update package.json to beta versions and add a script for publishing beta versions by @brettimus in https://github.com/autometrics-dev/autometrics-ts/pull/118
• 0.7.0 beta testing fixes by @brettimus in https://github.com/autometrics-dev/autometrics-ts/pull/120
• Use delta temporality for React example by @arendjr in https://github.com/autometrics-dev/autometrics-ts/pull/121
• Upgrade Rome to Biome by @arendjr in https://github.com/autometrics-dev/autometrics-ts/pull/122
• Fix default prometheus exporter port by @brettimus in https://github.com/autometrics-dev/autometrics-ts/pull/123
• Clear timer on handover by @arendjr in https://github.com/autometrics-dev/autometrics-ts/pull/124
• Update Quickstart and recipes by @arendjr in https://github.com/autometrics-dev/autometrics-ts/pull/116
• Update package versions and dependencies to 0.7.0 by @brettimus in https://github.com/autometrics-dev/autometrics-ts/pull/125
• Fix: support Bun runtime in the core library by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/127
• Warn on a potentially incorrect HTTP OTLP endpoint by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/126
• Publish 0.7.* of core and exporters by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/128

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/lib-v0.6...lib-v0.7.0

This is a beta release that includes several features to support usage in serverless functions alongside an aggregation gateway like Gravel.

What's Changed

See CHANGELOG.md

New Contributors

• @flenter made their first contribution in https://github.com/autometrics-dev/autometrics-ts/pull/72
• @arendjr made their first contribution in https://github.com/autometrics-dev/autometrics-ts/pull/75

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/v0.5...lib-v0.6

What's Changed

• Fix TS Plugin: show hover in wrapped functions by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/104

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/typescript-plugin-v0.5.3...typescript-plugin-v0.5

Publishes the Parcel transformer plugin with version 0.1.1 to npm.

What's Changed

• Fix typescript plugin with typescript 5 by @flenter in https://github.com/autometrics-dev/autometrics-ts/pull/78

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/parcel-transformer-v0.1.0...typescript-plugin-v0.5.3

This is the initial version of our Parcel transformer plugin.

What's Changed

• Update npm scripts by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/69
• Add a configurable 'html-comment' mode by @flenter in https://github.com/autometrics-dev/autometrics-ts/pull/72
• Edit Readme (and fix bugs) by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/71

New Contributors

• @flenter made their first contribution in https://github.com/autometrics-dev/autometrics-ts/pull/72

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/typescript-plugin-v0.5.1...typescript-plugin-v0.5.2

What's Changed

• Fix TS plugin errors by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/67
• Update CI and publishing workflows by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/68

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/v0.5...typescript-plugin-v0.5.1

What's Changed

• Fix: update convenience package by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/56
• Refactor & add more explicit decorator types by @oscarvz in https://github.com/autometrics-dev/autometrics-ts/pull/59
• Add caller label for "tracing lite" by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/51
• Prevent node:async_hooks from being run in the browser by @oscarvz in https://github.com/autometrics-dev/autometrics-ts/pull/60
• Fix bug when no options are passed in decorator by @oscarvz in https://github.com/autometrics-dev/autometrics-ts/pull/61
• Improve documentation, add API reference by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/62
• Fix build_info and add a unit test by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/64
• Release v0.5.0 by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/65

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/v0.4...v0.5

What's Changed

See also notes on CHANGELOG.md in project root

• Refactor TS plugin by @oscarvz in https://github.com/autometrics-dev/autometrics-ts/pull/41
• Update rome and vitest by @stephlow in https://github.com/autometrics-dev/autometrics-ts/pull/43
• Add support for concurrency tracking by @stephlow in https://github.com/autometrics-dev/autometrics-ts/pull/44
• Add link to Grafana dashboards in README by @brettimus in https://github.com/autometrics-dev/autometrics-ts/pull/46
• Add launch.json configs for easier TypeScript debugging by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/47
• Add support for applying autometrics decorator to classes by @oscarvz in https://github.com/autometrics-dev/autometrics-ts/pull/48
• Improve @Autometrics() decorator type signature by @oscarvz in https://github.com/autometrics-dev/autometrics-ts/pull/53
• Add build_info data by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/52
• Chores: rename library folders to make them easier to parse, add changelog, add license by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/54
• Release v0.4 by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/55

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/v0.3...v0.4

The major update in this release is support for adding SLOs to your functions. Read more about adding alerts and SLOs to your functions here and the rationale behind this approach here

What's Changed

• Fix a code sample in README and tweak some copy by @brettimus in https://github.com/autometrics-dev/autometrics-ts/pull/30
• Update React example by @oscarvz in https://github.com/autometrics-dev/autometrics-ts/pull/31
• SLO support by @stephlow in https://github.com/autometrics-dev/autometrics-ts/pull/32
• Add support for config changes by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/33
• Typo fixes by @oscarvz in https://github.com/autometrics-dev/autometrics-ts/pull/37
• Bump to v0.3 and publish by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/36

New Contributors

• @brettimus made their first contribution in https://github.com/autometrics-dev/autometrics-ts/pull/30

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/v0.2...v0.3

This release adds initial support for the library to be used in client-side applications (requiring a push gateway as intermediate). It also removes the TypeScript plugin from the convenience package - it now needs to be installed separately or (upcoming) as part of the VSCode extension.

What's Changed

• Add initial support for client side by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/27
• Publish v0.2.0 by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/29

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/v0.1.2...v0.2

• Improves guidance, updates examples to generate sample traffic by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/21
• Adds guidance for setting up a dev environment for the project by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/22
• Fixes a typescript plugin err by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/23
• Improvement: adds a bundled package option by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/24

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/v0.1.1...v0.1.2

Fixes and improvements

• Adds badges to the README by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/18
• Adds a utility function to ensure queries are fully URL encoded (including the parens) by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/19
• Fix publishing workflow by @keturiosakys in https://github.com/autometrics-dev/autometrics-ts/pull/20

Full Changelog: https://github.com/autometrics-dev/autometrics-ts/compare/v0.1...v0.1.1