Added cardinality warning to IPAddr/SocketAddr implementations

Author: rnijveld

src/encoding/text.rs

@@ -207,20 +207,38 @@ impl Encode for () {
     }
 }
 
+/// Warning: Using an IP address as a label is only useful when the number of
+/// distinct values is low (i.e. low cardinality). In all other cases you should
+/// combine your metrics into a single metric instead. Especially bad examples
+/// are: storing separate metrics for each client connecting to your public
+/// service or having a large fleet of servers and storing individual binding
+/// addresses.
 impl Encode for Ipv4Addr {
     fn encode(&self, writer: &mut dyn Write) -> Result<(), std::io::Error> {
         writer.write_all(self.to_string().as_bytes())?;
         Ok(())
     }
 }
 
+/// Warning: Using an IP address as a label is only useful when the number of
+/// distinct values is low (i.e. low cardinality). In all other cases you should
+/// combine your metrics into a single metric instead. Especially bad examples
+/// are: storing separate metrics for each client connecting to your public
+/// service or having a large fleet of servers and storing individual binding
+/// addresses.
 impl Encode for Ipv6Addr {
     fn encode(&self, writer: &mut dyn Write) -> Result<(), std::io::Error> {
         writer.write_all(self.to_string().as_bytes())?;
         Ok(())
     }
 }
 
+/// Warning: Using an IP address as a label is only useful when the number of
+/// distinct values is low (i.e. low cardinality). In all other cases you should
+/// combine your metrics into a single metric instead. Especially bad examples
+/// are: storing separate metrics for each client connecting to your public
+/// service or having a large fleet of servers and storing individual binding
+/// addresses.
 impl Encode for IpAddr {
     fn encode(&self, writer: &mut dyn Write) -> Result<(), std::io::Error> {
         match self {
@@ -230,20 +248,38 @@ impl Encode for IpAddr {
     }
 }
 
+/// Warning: Using a socket address as a label is only useful when the number of
+/// distinct values is low (i.e. low cardinality). In all other cases you should
+/// combine your metrics into a single metric instead. Especially bad examples
+/// are: storing separate metrics for each client connecting to your public
+/// service or having a large fleet of servers and storing individual binding
+/// addresses.
 impl Encode for SocketAddrV4 {
     fn encode(&self, writer: &mut dyn Write) -> Result<(), std::io::Error> {
         writer.write_all(self.to_string().as_bytes())?;
         Ok(())
     }
 }
 
+/// Warning: Using a socket address as a label is only useful when the number of
+/// distinct values is low (i.e. low cardinality). In all other cases you should
+/// combine your metrics into a single metric instead. Especially bad examples
+/// are: storing separate metrics for each client connecting to your public
+/// service or having a large fleet of servers and storing individual binding
+/// addresses.
 impl Encode for SocketAddrV6 {
     fn encode(&self, writer: &mut dyn Write) -> Result<(), std::io::Error> {
         writer.write_all(self.to_string().as_bytes())?;
         Ok(())
     }
 }
 
+/// Warning: Using a socket address as a label is only useful when the number of
+/// distinct values is low (i.e. low cardinality). In all other cases you should
+/// combine your metrics into a single metric instead. Especially bad examples
+/// are: storing separate metrics for each client connecting to your public
+/// service or having a large fleet of servers and storing individual binding
+/// addresses.
 impl Encode for SocketAddr {
     fn encode(&self, writer: &mut dyn Write) -> Result<(), std::io::Error> {
         match self {