coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 18:37:45 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
ca4a3ed961
kubo/docs/environment-variables.md
Marten Seemann 514411bedb
feat: opt-in Swarm.ResourceMgr (go-libp2p v0.18) (#8680) 
* update go-libp2p to v0.18.0

* initialize the resource manager

* add resource manager stats/limit commands

* load limit file when building resource manager

* log absent limit file

* write rcmgr to file when IPFS_DEBUG_RCMGR is set

* fix: mark swarm limit|stats as experimental

* feat(cfg): opt-in Swarm.ResourceMgr

This ensures we can safely test the resource manager without impacting
default behavior.

- Resource manager is disabled by default
    - Default for Swarm.ResourceMgr.Enabled is false for now
- Swarm.ResourceMgr.Limits allows user to tweak limits per specific
  scope in a way that is persisted across restarts
- 'ipfs swarm limit system' outputs human-readable json
- 'ipfs swarm limit system new-limits.json' sets new runtime limits
  (but does not change Swarm.ResourceMgr.Limits in the config)

Conventions to make libp2p devs life easier:
- 'IPFS_RCMGR=1 ipfs daemon' overrides the config and enables resource manager
- 'limit.json' overrides implicit defaults from libp2p (if present)

* docs(config): small tweaks

* fix: skip libp2p.ResourceManager if disabled

This ensures 'ipfs swarm limit|stats' work only when enabled.

* fix: use NullResourceManager when disabled

This reverts commit b19f7c9eca.
after clarification feedback from
https://github.com/ipfs/go-ipfs/pull/8680#discussion_r841680182

* style: rename IPFS_RCMGR to LIBP2P_RCMGR

preexisting libp2p toggles use LIBP2P_ prefix

* test: Swarm.ResourceMgr

* fix: location of opt-in limit.json and rcmgr.json.gz

Places these files inside of IPFS_PATH

* Update docs/config.md

* feat: expose rcmgr metrics when enabled (#8785)

* add metrics for the resource manager
* export protocol and service name in Prometheus metrics
* fix: expose rcmgr metrics only when enabled

Co-authored-by: Marcin Rataj <lidel@lidel.org>

* refactor: rcmgr_metrics.go

* refactor: rcmgr_defaults.go

This file defines implicit limit defaults used when Swarm.ResourceMgr.Enabled

We keep vendored copy to ensure go-ipfs is not impacted when go-libp2p
decides to change defaults in any of the future releases.

* refactor: adjustedDefaultLimits

Cleans up the way we initialize defaults and adds a fix for case
when connection manager runs with high limits.

It also hides `Swarm.ResourceMgr.Limits` until we have a better
understanding what syntax makes sense.

* chore: cleanup after a review

* fix: restore go-ipld-prime v0.14.2

* fix: restore go-ds-flatfs v0.5.1

Co-authored-by: Lucas Molas <schomatis@gmail.com>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
2022-04-07 21:06:35 -04:00

5.7 KiB
Raw Blame History

go-ipfs environment variables

IPFS_PATH

Sets the location of the IPFS repo (where the config, blocks, etc. are stored).

Default: ~/.ipfs

IPFS_LOGGING

Specifies the log level for go-ipfs.

IPFS_LOGGING is a deprecated alias for the GOLOG_LOG_LEVEL environment variable. See below.

IPFS_LOGGING_FMT

Specifies the log message format.

IPFS_LOGGING_FMT is a deprecated alias for the GOLOG_LOG_FMT environment variable. See below.

GOLOG_LOG_LEVEL

Specifies the log-level, both globally and on a per-subsystem basis. Level can be one of:

  • debug
  • info
  • warn
  • error
  • dpanic
  • panic
  • fatal

Per-subsystem levels can be specified with subsystem=level. One global level and one or more per-subsystem levels can be specified by separating them with commas.

Default: error

Example:

GOLOG_LOG_LEVEL="error,core/server=debug" ipfs daemon

Logging can also be configured at runtime, both globally and on a per-subsystem basis, with the ipfs log command.

GOLOG_LOG_FMT

Specifies the log message format. It supports the following values:

  • color -- human readable, colorized (ANSI) output
  • nocolor -- human readable, plain-text output.
  • json -- structured JSON.

For example, to log structured JSON (for easier parsing):

export GOLOG_LOG_FMT="json"

The logging format defaults to color when the output is a terminal, and nocolor otherwise.

GOLOG_FILE

Sets the file to which go-ipfs logs. By default, go-ipfs logs to standard error.

GOLOG_TRACING_FILE

Sets the file to which go-ipfs sends tracing events. By default, tracing is disabled.

This log can be read at runtime (without writing it to a file) using the ipfs log tail command.

Warning: Enabling tracing will likely affect performance.

IPFS_FUSE_DEBUG

Enables fuse debug logging.

Default: false

YAMUX_DEBUG

Enables debug logging for the yamux stream muxer.

Default: false

IPFS_FD_MAX

Sets the file descriptor limit for go-ipfs. If go-ipfs fails to set the file descriptor limit, it will log an error.

Defaults: 2048

IPFS_DIST_PATH

IPFS Content Path from which go-ipfs fetches repo migrations (when the daemon is launched with the --migrate flag).

Default: /ipfs/<cid> (the exact path is hardcoded in migrations.CurrentIpfsDist, depends on the IPFS version)

IPFS_NS_MAP

Adds static namesys records for deterministic tests and debugging. Useful for testing things like DNSLink without real DNS lookup.

Example:

$ IPFS_NS_MAP="dnslink-test1.example.com:/ipfs/bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am,dnslink-test2.example.com:/ipns/dnslink-test1.example.com" ipfs daemon
...
$ ipfs resolve -r /ipns/dnslink-test2.example.com
/ipfs/bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am

LIBP2P_TCP_REUSEPORT

go-ipfs tries to reuse the same source port for all connections to improve NAT traversal. If this is an issue, you can disable it by setting LIBP2P_TCP_REUSEPORT to false.

Default: true

LIBP2P_MUX_PREFS

Deprecated: Use the Swarm.Transports.Multiplexers config field.

Tells go-ipfs which multiplexers to use in which order.

Default: "/yamux/1.0.0 /mplex/6.7.0"

LIBP2P_RCMGR

Forces libp2p Network Resource Manager to be enabled (1) or disabled (0). When set, overrides Swarm.ResourceMgr.Enabled from the config.

Default: use config (not set)

LIBP2P_DEBUG_RCMGR

Enables tracing of libp2p Network Resource Manager and outputs it to rcmgr.json.gz

Default: disabled (not set)

Tracing

IPFS_TRACING

Enables OpenTelemetry tracing.

NOTE Tracing support is experimental: releases may contain tracing-related breaking changes.

Default: false

IPFS_TRACING_JAEGER

Enables the Jaeger exporter for OpenTelemetry.

For additional Jaeger exporter configuration, see: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#jaeger-exporter

Default: false

How to use Jaeger UI

One can use the jaegertracing/all-in-one Docker image to run a full Jaeger stack and configure go-ipfs to publish traces to it (here, in an ephemeral container):

$ docker run --rm -it --name jaeger \
    -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
    -p 5775:5775/udp \
    -p 6831:6831/udp \
    -p 6832:6832/udp \
    -p 5778:5778 \
    -p 16686:16686 \
    -p 14268:14268 \
    -p 14250:14250 \
    -p 9411:9411 \
    jaegertracing/all-in-one

Then, in other terminal, start go-ipfs with Jaeger tracing enabled:

$ IPFS_TRACING=1 IPFS_TRACING_JAEGER=1 ipfs daemon

Finally, the Jaeger UI is available at http://localhost:16686

IPFS_TRACING_OTLP_HTTP

Enables the OTLP HTTP exporter for OpenTelemetry.

For additional exporter configuration, see: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md

Default: false

IPFS_TRACING_OTLP_GRPC

Enables the OTLP gRPC exporter for OpenTelemetry.

For additional exporter configuration, see: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md

Default: false

IPFS_TRACING_FILE

Enables the file exporter for OpenTelemetry, writing traces to the given file in JSON format.

Example: "/var/log/ipfs-traces.json"

Default: "" (disabled)

IPFS_TRACING_RATIO

The ratio of traces to export, as a floating point value in the interval [0, 1].

Default: 1.0 (export all traces)