Skip to content

Add new tail command options#2095

Merged
kristianfreeman merged 2 commits into
productionfrom
tail-options
Aug 19, 2021
Merged

Add new tail command options#2095
kristianfreeman merged 2 commits into
productionfrom
tail-options

Conversation

@nataliescottdavidson

Copy link
Copy Markdown

No description provided.

@nataliescottdavidson
nataliescottdavidson requested a review from a team August 17, 2021 19:56
@nataliescottdavidson
nataliescottdavidson requested a review from a team as a code owner August 17, 2021 19:56
@haleycode haleycode added this to the Pages and Workers milestone Aug 17, 2021
@haleycode haleycode added the product:workers Related to Workers product label Aug 17, 2021
Comment thread products/workers/src/content/cli-wrangler/commands.md Outdated
- `--search $SEARCH`
- Filter by a text match in console.log messages
- `--status $STATUS`
- Filter by invocation status [possible values: ok, error, canceled]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this exactly how the values show up in the terminal or are they capitalized? (like 'OK, ERROR, CANCELED')

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are lowercased.

Comment on lines -264 to -285
### Dependencies

Wrangler tail uses cloudflared under the hood. If you are already using cloudflared, be sure you have installed the latest version. Otherwise, follow the [getting started guide](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup) for Cloudflare Tunnel.
`wrangler tail` will register a tailing session for your Worker, and start a server on `localhost` with a [tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup) that listens for incoming log requests from your Worker.

<Aside type="warning" header="Legacy issues with existing cloudflared configuration">

For versions before Wrangler 1.19.0, `wrangler tail` will not work with existing `cloudflared` configuration on a local machine. This is a well-known issue, [tracked in this Github issue](https://github.com/cloudflare/wrangler/issues/1844). To update your Wrangler version, refer to the [update documentation](/cli-wrangler/install-update#update).

To apply a temporary fix, rename your `cloudflared` config to allow `wrangler tail` to work correctly.

```sh
# Move config file when using `wrangler tail`.
# This will temporarily disable `cloudflared`.
$ mv ~/.cloudflared/config.yml ~/.cloudflared/config.yml.disabled

# Move file back when you need to use `cloudflared`.
$ mv ~/.cloudflared/config.yml.disabled ~/.cloudflared/config.yml
```

</Aside>

@deadlypants1973 deadlypants1973 Aug 18, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nataliescottdavidson
Kristian and I decided to leave this in temporarily in case people had not updated their wrangler version yet. I'm not sure how user experience goes, but is updating wrangler a pretty common-sense action for people to take or do they hold off on it? Or is the new update of not needing cloudflared make this whole section pointless? If it's pointless, I'm okay w deleting the whole thing.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also I know it went to Changes approved state on PR but need Kristian or Luke to look this PR over before merge.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's been about two weeks since we updated this page to mention the new version of wrangler. maybe instead of removing this entirely, we can update it to link to the upcoming blog post, and say "We've recently shipped an overhauled version of wrangler tail that removes a dependency on cloudflared. Make sure to update (link) and check out the blog post (link) to learn more." rough stab at copy, but the idea will be instead of giving them a list of instructions, we can start to point them towards the new features as incentive to upgrade

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

We need to deprecate the old version. I think that letting folks know that the <1.19.0 depends on cloudflared is good enough if they want to debug an earlier version

Comment thread products/workers/src/content/cli-wrangler/commands.md Outdated
- `--search $SEARCH`
- Filter by a text match in console.log messages
- `--status $STATUS`
- Filter by invocation status [possible values: ok, error, canceled]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

invocation status is different than http status, right? how would a user run into error/canceled states?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is referring to invocation status.

Comment thread products/workers/src/content/cli-wrangler/commands.md
@deadlypants1973
deadlypants1973 self-requested a review August 18, 2021 18:14
Comment thread products/workers/src/content/cli-wrangler/commands.md Outdated
@kristianfreeman
kristianfreeman merged commit eb50ae7 into production Aug 19, 2021
@kristianfreeman
kristianfreeman deleted the tail-options branch August 19, 2021 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:workers Related to Workers product

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants