Skip to content

Commit

Permalink
readme and insecure flag docs fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
agardnerIT committed Dec 22, 2023
1 parent 40f4262 commit 76926fa
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ If you like tracepusher and want to do the same thing with logs, check out [logp

See [try tracepusher in-browser without installation](https://agardnerit.github.io/tracepusher/try/).

## Standalone Binary

See [download and use tracepusher as a standalone binary](https://agardnerit.github.io/tracepusher/usage/standalone.md)

## Python3 Usage

See [use tracepusher as a Python script](https://agardnerit.github.io/tracepusher/usage/python).
Expand Down
21 changes: 11 additions & 10 deletions docs/reference/insecure-flag.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,23 @@ The `--insecure` is not available

The `--insecure` flag defaults to `false` with the intention of meaning insecure endpoints are not allowed. However, to provide ample migration time for end users, the behaviour is as follows:

- `--insecure` flag is omitted
#### `--insecure` flag is omitted

This is the expected behaviour of everyone migrating from v0.8 to v0.9.
The flag defaults to `false` BUT will still allow `http://` endpoints, just like before.
This is the expected behaviour of everyone migrating from v0.8 to v0.9.

The flag defaults to `false` BUT will still allow `http://` endpoints, just like before.

Tracepusher will emit a soft `WARNING` message to inform users of the upcoming breaking change, like this:
Tracepusher will emit a soft `WARNING` message to inform users of the upcoming breaking change, like this:

```
WARN: --insecure flag is omitted or is set to false. Prior to v1.0 tracepusher still works as expected (span is sent). In v1.0 and above, you MUST set '--insecure true' if you want to send to an http:// endpoint. See https://github.com/agardnerIT/tracepusher/issues/78
```
```
WARN: --insecure flag is omitted or is set to false. Prior to v1.0 tracepusher still works as expected (span is sent). In v1.0 and above, you MUST set '--insecure true' if you want to send to an http:// endpoint. See https://github.com/agardnerIT/tracepusher/issues/78
```

- `--insecure` flag is explicitly set to false
#### `--insecure` flag is explicitly set to false

From v0.9 upwards, users are encouraged to get into the best practice habit of explicitly setting this to `false` or `true`.
From v0.9 upwards, users are encouraged to get into the best practice habit of explicitly setting this to `false` or `true`.

Otherwise, for v0.9.*, the behaviour is as above.
Otherwise, for v0.9.*, the behaviour is as above.

### v1.0

Expand Down

0 comments on commit 76926fa

Please sign in to comment.