Skip to content

Commit 3622741

Browse files
authored
Update CHANGELOG (#147)
1 parent 30d790a commit 3622741

File tree

2 files changed

+68
-8
lines changed

2 files changed

+68
-8
lines changed

CHANGELOG.md

+64-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,70 @@
11
# Changelog
22

3-
## [unreleased]
3+
## [v1.0.0]
44

5-
- **Breaking change:** Split the exporters into separate packages. Users will
6-
need to explicitly choose an exporter and call its `init()` function.
7-
- (_experimental_) Push metrics to gateway "eagerly" when pushInterval is set to 0
8-
- Log error when fetch is not defined in push context
5+
This release features full compliance with the
6+
[Autometrics v1.0.0 specification](https://github.com/autometrics-dev/autometrics-shared/blob/main/specs/autometrics_v1.0.0.md)
7+
as well as first-class [Deno](https://deno.com/) support. Also, our decorators
8+
have been updated to match the
9+
[Stage 3 ECMAScript decorators proposal](https://github.com/tc39/proposal-decorators).
10+
11+
### Changed
12+
13+
- **BREAKING:** Labels are submitted with dots instead of underscores when
14+
exported through OTLP. This should not affect exports to Prometheus.
15+
- **BREAKING:** The `@Autometrics` decorator is now compliant with the
16+
[Stage 3 ECMAScript decorators proposal](https://github.com/tc39/proposal-decorators).
17+
For the legacy TypeScript decorators, please use `@AutometricsLegacy` instead.
18+
- **BREAKING:** *Autometrics 1.0:* `caller.function` and `caller.module` have
19+
been changed to match the specification.
20+
- Deno has become a first-class supported platform.
21+
22+
### Added
23+
24+
- *Autometrics 1.0:* Added support for the `service.name` label.
25+
- *Autometrics 1.0:* Added support for the `repository.url` and
26+
`repository.provider` labels.
27+
- *Autometrics 1.0:* Added support for excluding individual methods from the
28+
class decorator, using `@Autometrics({ skip: true })`. This also works with
29+
the legacy decorator.
30+
- *Autometrics 1.0:* Users should see a warning in their console if they've
31+
configured an invalid objective name.
32+
33+
### Fixed
34+
35+
- Fixed `this` handling in the wrappers and decorators.
36+
- Fixed using the `autometrics` package with web bundlers such as Parcel and
37+
WebPack.
38+
- Fixed an issue where caller information sometimes wasn't submitted.
39+
40+
## [v0.7.0]
41+
42+
### Changed
43+
44+
**BREAKING:** v0.7 is a big change to how the Autometrics library works in
45+
JavaScript. The core library interface of wrappers and decorators remains the
46+
same and will collect the metrics as previously, however it will not export
47+
them. For that purpose exporters are now separate to the library itself allowing
48+
the user more control as to how they want to set up the metrics collection: as a
49+
pull endpoint for Prometheus, push gateway, OpenTelemetry collector or something
50+
else.
51+
52+
- Users need to explicitly choose an exporter and call its `init()` function.
53+
- *Experimental:* Eagerly push metrics when `pushInterval` is set to 0.
54+
55+
### Added
56+
57+
- Support Bun runtime in the core library.
58+
- Warn on a potentially incorrect HTTP OTLP endpoint.
59+
- *Experimental:* Initial Gravel Gateway Support.
60+
61+
### Fixed
62+
63+
- Clear timer on handover.
64+
- Log error when fetch is not defined in push context.
65+
- Fix default Prometheus exporter port.
66+
- Various smaller bugfixes.
67+
- Updated all our examples.
968

1069
## [v0.6.0] - @autometrics/autometrics - 2023-07-20
1170

CONTRIBUTING.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,11 @@ you want to publish you will need to create a separate release.
128128
1. Ensure that the version number in the root `package.json` is up to date
129129
2. Run `just build-all` to make sure lock files in the examples are updated
130130
correctly.
131-
3. Make sure that all tests have successfully passed in the latest commit on
131+
3. Update the `CHANGELOG.md`.
132+
4. Make sure that all tests have successfully passed in the latest commit on
132133
`main` (the CI will run one more time before publishing it to NPM)
133-
4. Create a release on GitHub along with a respective tag for each package:
134+
5. Create a release on GitHub along with a respective tag for each package:
134135
- `lib/` (main autometrics library) → tag: `lib-*` (e.g.: `lib-v0.7`)
135136
- `typescript-plugin/` → tag: `typescript-plugin-*`
136137
- `parcel-transformer-autometrics/` → tag: `parcel-transformer-*`
137-
5. When the release is published, the relevant GitHub workflow will kick off.
138+
6. When the release is published, the relevant GitHub workflow will kick off.

0 commit comments

Comments
 (0)