OverOps encrypts all your data before it leaves your servers, but on certain occasions, you may have data that you don’t want OverOps to capture at all. Personally Identifiable Information (PII) often requires special and careful handling, and with PII filtering, this information will never leave your server.
To see the current privacy settings or make any changes, click on your account name in the upper right of the OverOps dashboard and choose “Security Settings” from the drop down menu. Note that security settings for PII are available in OverOps version 3.8.3 and up. Click here to learn how to upgrade your installation to the latest version.
By default, filtering is turned on for an extensive range of PII, such as credit cards and IP addresses. To make changes to the default settings or turn filtering on or off, admin privileges are required. Non-admin users will be able to see the current settings, but will not be able to edit or remove filters, and will not see the box to enter new filters.
Security settings box
There are three methods for filtering out PII within OverOps: Patterns, Code Identifiers, and Classes. Within each category, you have the ability to add, delete, or modify filters based on your needs.
The first method of omitting PII in OverOps is patterns. When the agent on one of your JVMs recognizes a pattern from the filter list in your code, it will not collect that information at all. Patterns examine the value of a variable in your code rather than the name or identifier for a variable. The default settings for patterns include credit cards, Internet addresses, phone numbers, location addresses, and IDs. You can turn patterns on and off by clicking the filtering slider next to the pattern name.
Example list of patterns filtered by OverOps. IPv6 address filtering is turned off here.
Patterns are written as Regular Expressions. To add new patterns, click on the blue Add button, enter the Regular Expression you wish to use for the pattern and the pattern’s name, then press “Save.”
Add pattern dialog box
The second method of hiding PII in OverOps is code identifiers. When a JVM agent on your server encounters a variable name on the filtered list, it will not collect that variable information. Code identifiers are used to check the names of a variable rather than its value. To view the list of variables currently being filtered, select the Code Identifiers tab. You can delete variables by mousing over them and clicking the ‘x’ that appears.
Code identifiers filter list
To add a new variable to the filters list, type it into the box beneath the list and press enter. You can enter multiple variable names at one time by separating them with commas.
Entering multiple filters at once
The third filtering method is classes. Under the Classes tab, you can add, modify, or delete names for entire classes. When the JVM agent encounters one of the listed classes, it will not send any of the data from that class off your server. No classes are filtered by default, but you can add them in the Classes tab the same way you add code identifiers.
The classes filtering tab
Changes you make in the security settings are implemented automatically — no Apply or Save buttons needed. Any changed made are applied to all errors and exceptions OverOps captures from that point on. Changes to settings are not applied retroactively. To undo all the changed you’ve made and restore the default settings, click on the bottom left of the security settings window.
When the JVM agent on your server encounters information that has been included in your PII settings, it will redact that info and not send it off your server. When an error or exception occurs that contains the PII you are filtering, the PII will be represented in the dashboard as asterisks.
Below is how PII will display in each view:
- Code View: Patterns, code identifiers, and classes are applied
An example of an error in OverOps with a PII filtered variable in Code View
- Log View: Only patterns are applied
An example of an error in OverOps with a PII filtered log line in Log View
- JVM View: Only code identifiers are applied
An example of an error in OverOps with a PII filtered JVM argument in JVM View