introspection: rename package, rm ListenAddr() from interface.

introspect/doc.go → introspection/doc.go

@@ -1,9 +1,9 @@
-// Package introspect is EXPERIMENTAL. It is subject to heavy change, and it
+// Package introspection is EXPERIMENTAL. It is subject to heavy change, and it
 // WILL change. For now, it is the simplest implementation to power the
 // proof-of-concept of the libp2p introspection framework.
 //
 // Package introspect contains the abstract skeleton of the introspection system
 // of go-libp2p. It holds the introspection data schema, and the primitives that
 // allow subsystems to register data providers, and clients to fetch the current
 // state of the system.
-package introspect
+package introspection

introspect/introspect.go → introspection/introspect.go

@@ -1,25 +1,24 @@
-package introspect
+package introspection
 
-import introspect_pb "github.com/libp2p/go-libp2p-core/introspect/pb"
+import introspection_pb "github.com/libp2p/go-libp2p-core/introspection/pb"
 
 // ProtoVersion is the current version of the introspection protocol.
 const ProtoVersion uint32 = 1
 
 // EXPERIMENTAL. Introspector allows other sub-systems/modules to register
 // metrics/data providers AND also enables clients to fetch the current state of
 // the system.
+//
+// Introspector implementations are usually injected in introspection endpoints
+// (e.g. the default WebSocket endpoint) to serve the data to clients, but they
+// can also be used separately for embedding or testing.
 type Introspector interface {
-
 	// EXPERIMENTAL. RegisterDataProviders allows sub-systems/modules to
 	// register callbacks that supply introspection data.
 	RegisterDataProviders(p *DataProviders) error
 
 	// EXPERIMENTAL. FetchFullState returns the full state of the system, by
 	// calling all known data providers and returning a merged cross-cut of the
 	// running system.
-	FetchFullState() (*introspect_pb.State, error)
-
-	// EXPERIMENTAL. ListenAddrs returns the addresses on which the
-	// introspection server endpoint is listening for clients.
-	ListenAddrs() []string
+	FetchFullState() (*introspection_pb.State, error)
 }