Skip to content

Commit 131229f

Browse files
authored
move the docs URL (#434)
1 parent 12a29ac commit 131229f

File tree

15 files changed

+29
-29
lines changed

15 files changed

+29
-29
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: true
22
contact_links:
33
- name: 💬 Join Slack
4-
url: 'https://docs.pydantic.dev/logfire/help/#slack'
4+
url: 'https://logfire.pydantic.dev/docs/help/#slack'
55
about: Join the Logfire Slack to ask questions, get help and chat about Logfire

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
### BREAKING CHANGES
2222

23-
* **System metrics are no longer collected by default** when the correct dependency is installed. Use [`logfire.instrument_system_metrics()`](https://docs.pydantic.dev/logfire/integrations/system_metrics/) to enable system metrics collection. **If you are simply using the old 'Basic System Metrics' dashboard, then no further code changes are required, but that dashboard will no longer work properly and you should create a new dashboard from the template named 'Basic System Metrics (Logfire)'**. If you were using other collected metrics, see the documentation for how to collect those. By @alexmojaki in https://github.com/pydantic/logfire/pull/373
23+
* **System metrics are no longer collected by default** when the correct dependency is installed. Use [`logfire.instrument_system_metrics()`](https://logfire.pydantic.dev/docs/integrations/system_metrics/) to enable system metrics collection. **If you are simply using the old 'Basic System Metrics' dashboard, then no further code changes are required, but that dashboard will no longer work properly and you should create a new dashboard from the template named 'Basic System Metrics (Logfire)'**. If you were using other collected metrics, see the documentation for how to collect those. By @alexmojaki in https://github.com/pydantic/logfire/pull/373
2424
* Stop collecting package versions by @alexmojaki in https://github.com/pydantic/logfire/pull/387
2525
* Don't auto-trace generators by @alexmojaki in https://github.com/pydantic/logfire/pull/386
2626
* Disable ASGI send/receive spans by default by @alexmojaki in https://github.com/pydantic/logfire/pull/371
@@ -34,7 +34,7 @@
3434

3535
(Previously released as `v0.50.0`, then yanked due to https://github.com/pydantic/logfire/issues/367)
3636

37-
* **BREAKING CHANGES:** Separate sending to Logfire from using standard OTEL environment variables by @alexmojaki in https://github.com/pydantic/logfire/pull/351. See https://docs.pydantic.dev/logfire/guides/advanced/alternative_backends/ for details. Highlights:
37+
* **BREAKING CHANGES:** Separate sending to Logfire from using standard OTEL environment variables by @alexmojaki in https://github.com/pydantic/logfire/pull/351. See https://logfire.pydantic.dev/docs/guides/advanced/alternative_backends/ for details. Highlights:
3838
* `OTEL_EXPORTER_OTLP_ENDPOINT` is no longer just an alternative to `LOGFIRE_BASE_URL`. Setting `OTEL_EXPORTER_OTLP_ENDPOINT`, `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`, and/or `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT` will set up appropriate exporters *in addition* to sending to Logfire, which must be turned off separately if desired. These are basic exporters relying on OTEL defaults. In particular they don't use our custom retrying logic.
3939
* `LOGFIRE_BASE_URL` / `logfire.configure(base_url=...)` is now only intended for actual alternative Logfire backends, which are currently only available to Logfire developers, and unlike `OTEL_EXPORTER_OTLP_ENDPOINT` requires authenticating with Logfire.
4040
* Pending spans are only sent to logfire-specific exporters.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,29 @@ What sets Logfire apart:
1717
- **OpenTelemetry:** Logfire is an opinionated wrapper around OpenTelemetry, allowing you to leverage existing tooling, infrastructure, and instrumentation for many common Python packages, and enabling support for virtually any language.
1818
- **Pydantic Integration:** Understand the data flowing through your Pydantic models and get built-in analytics on validations.
1919

20-
See the [documentation](https://docs.pydantic.dev/logfire/) for more information.
20+
See the [documentation](https://logfire.pydantic.dev/docs/) for more information.
2121

2222
**Feel free to report issues and ask any questions about Logfire in this repository!**
2323

2424
This repo contains the Python SDK for `logfire` and documentation; the server application for recording and displaying data is closed source.
2525

2626
## Using Logfire
2727

28-
This is a very brief overview of how to use Logfire, the [documentation](https://docs.pydantic.dev/logfire/) has much more detail.
28+
This is a very brief overview of how to use Logfire, the [documentation](https://logfire.pydantic.dev/docs/) has much more detail.
2929

3030
### Install
3131

3232
```bash
3333
pip install logfire
3434
```
35-
[_(learn more)_](https://docs.pydantic.dev/logfire/guides/first_steps/#install)
35+
[_(learn more)_](https://logfire.pydantic.dev/docs/guides/first_steps/#install)
3636

3737
## Authenticate
3838

3939
```bash
4040
logfire auth
4141
```
42-
[_(learn more)_](https://docs.pydantic.dev/logfire/guides/first_steps/#authentication)
42+
[_(learn more)_](https://logfire.pydantic.dev/docs/guides/first_steps/#authentication)
4343

4444
### Manual tracing
4545

@@ -56,11 +56,11 @@ with logfire.span('Asking the user their {question}', question='age'):
5656
dob = date.fromisoformat(user_input)
5757
logfire.debug('{dob=} {age=!r}', dob=dob, age=date.today() - dob)
5858
```
59-
[_(learn more)_](https://docs.pydantic.dev/logfire/guides/onboarding_checklist/add_manual_tracing/)
59+
[_(learn more)_](https://logfire.pydantic.dev/docs/guides/onboarding_checklist/add_manual_tracing/)
6060

6161
### Integration
6262

63-
Or you can also avoid manual instrumentation and instead integrate with [lots of popular packages](https://docs.pydantic.dev/logfire/integrations/), here's an example of integrating with FastAPI:
63+
Or you can also avoid manual instrumentation and instead integrate with [lots of popular packages](https://logfire.pydantic.dev/docs/integrations/), here's an example of integrating with FastAPI:
6464

6565
```py
6666
import logfire
@@ -82,11 +82,11 @@ async def add_user(user: User):
8282
# we would store the user here
8383
return {'message': f'{user.name} added'}
8484
```
85-
[_(learn more)_](https://docs.pydantic.dev/logfire/integrations/fastapi/)
85+
[_(learn more)_](https://logfire.pydantic.dev/docs/integrations/fastapi/)
8686

8787
Logfire gives you a view into how your code is running like this:
8888

89-
![Logfire screenshot](https://docs.pydantic.dev/logfire/images/index/logfire-screenshot-fastapi-200.png)
89+
![Logfire screenshot](https://logfire.pydantic.dev/docs/images/index/logfire-screenshot-fastapi-200.png)
9090

9191
## Contributing
9292

logfire-api/logfire_api/_internal/config.pyi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,10 @@ def configure(*, send_to_logfire: bool | Literal['if-token-present'] | None = No
8989
fast_shutdown: Whether to shut down exporters and providers quickly, mostly used for tests. Defaults to `False`.
9090
scrubbing: Options for scrubbing sensitive data. Set to `False` to disable.
9191
inspect_arguments: Whether to enable
92-
[f-string magic](https://docs.pydantic.dev/logfire/guides/onboarding_checklist/add_manual_tracing/#f-strings).
92+
[f-string magic](https://logfire.pydantic.dev/docs/guides/onboarding_checklist/add_manual_tracing/#f-strings).
9393
If `None` uses the `LOGFIRE_INSPECT_ARGUMENTS` environment variable.
9494
Defaults to `True` if and only if the Python version is at least 3.11.
95-
sampling: Sampling options. See the [sampling guide](https://docs.pydantic.dev/logfire/guides/advanced/sampling/).
95+
sampling: Sampling options. See the [sampling guide](https://logfire.pydantic.dev/docs/guides/advanced/sampling/).
9696
"""
9797

9898
@dataclasses.dataclass

logfire-api/logfire_api/_internal/main.pyi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ class Logfire:
344344
!!! note
345345
This function MUST be called before any of the modules to be traced are imported.
346346
347-
Generator functions will not be traced for reasons explained [here](https://docs.pydantic.dev/logfire/guides/advanced/generators/).
347+
Generator functions will not be traced for reasons explained [here](https://logfire.pydantic.dev/docs/guides/advanced/generators/).
348348
349349
This works by inserting a new meta path finder into `sys.meta_path`, so inserting another finder before it
350350
may prevent it from working.
@@ -652,7 +652,7 @@ class Logfire:
652652
def instrument_system_metrics(self, config: SystemMetricsConfig | None = None, base: SystemMetricsBase = 'basic') -> None:
653653
"""Collect system metrics.
654654
655-
See [the guide](https://docs.pydantic.dev/logfire/integrations/system_metrics/) for more information.
655+
See [the guide](https://logfire.pydantic.dev/docs/integrations/system_metrics/) for more information.
656656
657657
Args:
658658
config: A dictionary where the keys are metric names

logfire-api/logfire_api/sampling/_tail_sampling.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ class TailSamplingSpanInfo:
6060
class SamplingOptions:
6161
"""Options for [`logfire.configure(sampling=...)`][logfire.configure(sampling)].
6262
63-
See the [sampling guide](https://docs.pydantic.dev/logfire/guides/advanced/sampling/).
63+
See the [sampling guide](https://logfire.pydantic.dev/docs/guides/advanced/sampling/).
6464
"""
6565
head: float | Sampler = ...
6666
tail: Callable[[TailSamplingSpanInfo], float] | None = ...

logfire/_internal/cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
from .utils import read_toml_file
3737

3838
BASE_OTEL_INTEGRATION_URL = 'https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/'
39-
BASE_DOCS_URL = 'https://docs.pydantic.dev/logfire'
39+
BASE_DOCS_URL = 'https://logfire.pydantic.dev/docs'
4040
INTEGRATIONS_DOCS_URL = f'{BASE_DOCS_URL}/integrations/'
4141

4242
HOME_LOGFIRE.mkdir(exist_ok=True)
@@ -413,7 +413,7 @@ def _main(args: list[str] | None = None) -> None:
413413
parser = argparse.ArgumentParser(
414414
prog='logfire',
415415
description='The CLI for Pydantic Logfire.',
416-
epilog='See https://docs.pydantic.dev/logfire/reference/cli/ for more detailed documentation.',
416+
epilog='See https://logfire.pydantic.dev/docs/reference/cli/ for more detailed documentation.',
417417
)
418418

419419
parser.add_argument('--version', action='store_true', help='show the version and exit')

logfire/_internal/config.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -202,10 +202,10 @@ def configure( # noqa: D417
202202
fast_shutdown: Whether to shut down exporters and providers quickly, mostly used for tests. Defaults to `False`.
203203
scrubbing: Options for scrubbing sensitive data. Set to `False` to disable.
204204
inspect_arguments: Whether to enable
205-
[f-string magic](https://docs.pydantic.dev/logfire/guides/onboarding_checklist/add_manual_tracing/#f-strings).
205+
[f-string magic](https://logfire.pydantic.dev/docs/guides/onboarding_checklist/add_manual_tracing/#f-strings).
206206
If `None` uses the `LOGFIRE_INSPECT_ARGUMENTS` environment variable.
207207
Defaults to `True` if and only if the Python version is at least 3.11.
208-
sampling: Sampling options. See the [sampling guide](https://docs.pydantic.dev/logfire/guides/advanced/sampling/).
208+
sampling: Sampling options. See the [sampling guide](https://logfire.pydantic.dev/docs/guides/advanced/sampling/).
209209
"""
210210
processors = deprecated_kwargs.pop('processors', None) # type: ignore
211211
if processors is not None: # pragma: no cover
@@ -984,7 +984,7 @@ def _get_user_token(cls, logfire_api_url: str) -> str:
984984
"""You are not authenticated. Please run `logfire auth` to authenticate.
985985
986986
If you are running in production, you can set the `LOGFIRE_TOKEN` environment variable.
987-
To create a write token, refer to https://docs.pydantic.dev/logfire/guides/advanced/creating_write_tokens/
987+
To create a write token, refer to https://logfire.pydantic.dev/docs/guides/advanced/creating_write_tokens/
988988
"""
989989
)
990990

logfire/_internal/formatter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ def warn_formatting(msg: str):
453453
f' Ensure you are either:\n'
454454
' (1) passing an f-string directly, with inspect_arguments enabled and working, or\n'
455455
' (2) passing a literal `str.format`-style template, not a preformatted string.\n'
456-
' See https://docs.pydantic.dev/logfire/guides/onboarding_checklist/add_manual_tracing/#messages-and-span-names.\n'
456+
' See https://logfire.pydantic.dev/docs/guides/onboarding_checklist/add_manual_tracing/#messages-and-span-names.\n'
457457
f' The problem was: {msg}',
458458
category=FormattingFailedWarning,
459459
)

logfire/_internal/main.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -774,7 +774,7 @@ def install_auto_tracing(
774774
!!! note
775775
This function MUST be called before any of the modules to be traced are imported.
776776
777-
Generator functions will not be traced for reasons explained [here](https://docs.pydantic.dev/logfire/guides/advanced/generators/).
777+
Generator functions will not be traced for reasons explained [here](https://logfire.pydantic.dev/docs/guides/advanced/generators/).
778778
779779
This works by inserting a new meta path finder into `sys.meta_path`, so inserting another finder before it
780780
may prevent it from working.
@@ -1269,7 +1269,7 @@ def instrument_system_metrics(
12691269
) -> None:
12701270
"""Collect system metrics.
12711271
1272-
See [the guide](https://docs.pydantic.dev/logfire/integrations/system_metrics/) for more information.
1272+
See [the guide](https://logfire.pydantic.dev/docs/integrations/system_metrics/) for more information.
12731273
12741274
Args:
12751275
config: A dictionary where the keys are metric names

0 commit comments

Comments
 (0)