coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 10:27:46 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

chore: add comments to peerlog plugin about being unsupported

Browse Source 
and also about the ugly config semantics
This commit is contained in:
guseggert 2021-08-25 14:43:48 -04:00 committed by Gus Eggert
parent c3ac1b4282
commit ae09459e39
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
plugin/plugins/peerlog/peerlog.go
View File

@ -36,7 +36,7 @@ type plEvent struct {
peer peer.ID
}
// Log all the PeerIDs we see
// Log all the PeerIDs. This is considered internal, unsupported, and may break at any point.
//
// Usage:
// GOLOG_FILE=~/peer.log IPFS_LOGGING_FMT=json ipfs daemon
@ -67,6 +67,11 @@ func (*peerLogPlugin) Version() string {
return "0.1.0"
}
// extractEnabled extracts the "Enabled" field from the plugin config.
// Do not follow this as a precedent, this is only applicable to this plugin,
// since it is internal-only, unsupported functionality.
// For supported functionality, we should rework the plugin API to support this use case
// of including plugins that are disabled by default.
func extractEnabled(config interface{}) bool {
// plugin is disabled by default, unless Enabled=true
if config == nil {