Class RedactableArgument


  • public class RedactableArgument
    extends Object
    Represents a logging argument which is subject to redaction.
    Since:
    1.5.3
    Author:
    Michael Nitschinger
    • Method Detail

      • user

        public static RedactableArgument user​(Object message)
        A redactable argument of user data. User data is data that is stored into Couchbase by the application user account, including:
        • Key and value pairs in JSON documents, or the key exclusively
        • Application/Admin usernames that identify the human person
        • Query statements included in the log file collected by support that leak the document fields (Select floor_price from stock).
        • Names and email addresses asked during product registration and alerting
        • Usernames
        • Document xattrs
        Parameters:
        message - the message to redact.
        Returns:
        a new RedactableArgument.
      • meta

        public static RedactableArgument meta​(Object message)
        A redactable argument of meta data. Metadata is logical data needed by Couchbase to store and process User data, including:
        • Cluster name
        • Bucket names
        • DDoc/view names
        • View code
        • Index names
        • Mapreduce Design Doc Name and Definition (IP)
        • XDCR Replication Stream Names
        • And other couchbase resource specific meta data
        Parameters:
        message - the message to redact.
        Returns:
        a new RedactableArgument.
      • system

        public static RedactableArgument system​(Object message)
        A redactable argument of system data. System data is data from other parts of the system Couchbase interacts with over the network, including:
        • IP addresses
        • IP tables
        • Hosts names
        • Ports
        • DNS topology
        Parameters:
        message - the message to redact.
        Returns:
        a new RedactableArgument.
      • message

        public String message()
        The message of this redactable argument.