Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: disable observability on deploy if not explicitly defined in config #6776

Merged

Conversation

zebp
Copy link
Contributor

@zebp zebp commented Sep 19, 2024

What this PR solves / how to test

Changes the deploy behavior deploys using the new versions API to disable observability if it isn't explicitly defined in the user's wrangler.toml. This behaves differently from how logpush and tail_consumers work, where they must be explicitly removed, but we decided that this PR's behavior matches user expectations better.

Fixes WO-186

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Tests included
    • Tests not necessary because:
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required
    • Not required because: minor bug fix for unreleased feature
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Changeset included
    • Changeset not necessary because: minor bug fix for unreleased feature
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because: minor bug fix for unreleased feature

@zebp zebp requested a review from a team as a code owner September 19, 2024 14:31
Copy link

changeset-bot bot commented Sep 19, 2024

🦋 Changeset detected

Latest commit: a613f11

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
wrangler Patch
@cloudflare/vitest-pool-workers Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Sep 19, 2024

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10944273668/npm-package-wrangler-6776

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/6776/npm-package-wrangler-6776

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10944273668/npm-package-wrangler-6776 dev path/to/script.js
Additional artifacts:
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10944273668/npm-package-create-cloudflare-6776 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10944273668/npm-package-cloudflare-kv-asset-handler-6776
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10944273668/npm-package-miniflare-6776
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10944273668/npm-package-cloudflare-pages-shared-6776
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10944273668/npm-package-cloudflare-vitest-pool-workers-6776
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10944273668/npm-package-cloudflare-workers-editor-shared-6776
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10944273668/npm-package-cloudflare-workers-shared-6776

Note that these links will no longer work once the GitHub Actions artifact expires.


[email protected] includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240909.3
workerd 1.20240909.0 1.20240909.0
workerd --version 1.20240909.0 2024-09-09

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

@zebp zebp force-pushed the zeb/observability-disabled-if-missing branch from f7bf04a to 76d4929 Compare September 19, 2024 15:22
Changes the deploy behavior deploys using the new versions API to disable observability if it isn't explicitly defined in the user's wrangler.toml.
@zebp zebp force-pushed the zeb/observability-disabled-if-missing branch from 76d4929 to a613f11 Compare September 19, 2024 15:36
@edmundhung edmundhung merged commit 02de103 into cloudflare:main Sep 19, 2024
19 of 21 checks passed
@zebp zebp deleted the zeb/observability-disabled-if-missing branch September 19, 2024 16:22
taylorlee added a commit that referenced this pull request Oct 24, 2024
In addition to logpush and tail_consumers, patch observability settings
on version deploy. This still doesn't quite match the behavior of
"wrangler deploy", which will disable observability if it is not defined
in wrangler.toml (as of #6776), but at least this is more correct for now.
taylorlee added a commit that referenced this pull request Oct 24, 2024
In addition to logpush and tail_consumers, patch observability settings
on version deploy. This still doesn't quite match the behavior of
"wrangler deploy", which will disable observability if it is not defined
in wrangler.toml (as of #6776), but at least this is more correct for now.
taylorlee added a commit that referenced this pull request Oct 25, 2024
In addition to logpush and tail_consumers, patch observability settings
on version deploy. This still doesn't quite match the behavior of
"wrangler deploy", which will disable observability if it is not defined
in wrangler.toml (as of #6776), but at least this is more correct for now.
taylorlee added a commit that referenced this pull request Oct 25, 2024
In addition to logpush and tail_consumers, patch observability settings
on version deploy. This still doesn't quite match the behavior of
"wrangler deploy", which will disable observability if it is not defined
in wrangler.toml (as of #6776), but at least this is more correct for now.
taylorlee added a commit that referenced this pull request Oct 28, 2024
In addition to logpush and tail_consumers, patch observability settings
on version deploy. This still doesn't quite match the behavior of
"wrangler deploy", which will disable observability if it is not defined
in wrangler.toml (as of #6776), but at least this is more correct for now.
taylorlee added a commit that referenced this pull request Oct 29, 2024
In addition to logpush and tail_consumers, patch observability settings
on version deploy. This still doesn't quite match the behavior of
"wrangler deploy", which will disable observability if it is not defined
in wrangler.toml (as of #6776), but at least this is more correct for now.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants