Create and Edit a Partition
Partitions provide three primary functions:
- Enhance performance
- Enhance searches
- Enhance retention options
Partitions ingest your messages in real time, and differ from Scheduled Views, which backfill with aggregate data. Partitions begin building a non-aggregate index from the time the Partition is created and only index data moving forward (from the time of creation).
See Partitions for limitations.
Prerequisites
To create or edit a Partition, you must be an account Administrator or have the Manage Partitions role capability. It's important to note that Partitions only affect data generated from the date of their creation onwards; any data predating their establishment is not included.
Create a Partition
- In the Sumo Logic left navigation bar, go to Manage Data > Logs, then select the Partitions tab.
- Click + Add Partition.
- The Create New Partition pane appears.
- Name. Enter a name for the Partition. Partitions must be named alphanumerically, with no special characters, with the exception of underscores (
_
). However, a Partition name cannot start withsumologic_
or an underscore_
. - Routing Expression. Enter a keyword search expression that matches the data you want to have in the Partition, using built-in metadata or custom metadata fields.
- Retention Period. Enter the number of days you wish to retain the data in the Partition, or click Apply the retention period of sumologic_default.
- Compliance data. Click the Mark as compliance data to not change the routing expression and the retention period for partitions.
- Data Forwarding. If you want to forward the data in the Partition to a cloud environment, click Enable Data Forwarding and specify the necessary information for the options that appear. For more information, see Data Forwarding.
Enhance search and retention
- To learn how to run a search against a Partition, see Run a Search Against a Partition and Optimize Your Search with Partitions.
- To learn about data retention periods and how to modify them, see Manage Indexes with Variable Retention.
Best practices for optimum performance
When designing partitions, keep the following in mind:
- Avoid using queries that are subject to change. In order to benefit from using Partitions, they should be used for long-term message organization.
- Make the query as specific as possible. Making the query specific will reduce the amount of data in the Partition, which increases search performance.
- Keep the query flexible. Use a flexible query, such as
sourceCategory=*Apache*
, so that metadata can be adjusted without breaking the query. - Group data together that is most often used together. For example, create Partitions for categories such as web data, security data, or errors.
- Group data together that is used by teams. Partitions are an excellent way to organize messages by role and teams within your organization.
- Avoid including too much data in your partition. Send between 2% and 20% of your data to a Partition. Including 90% of the data in your index in a Partition won’t improve search performance.
- Don’t create overlapping partitions. With multiple Partitions, messages could be duplicated if you create routing expressions that overlap. For example, if you have the following Partitions, messages for
_sourceCategory=prod/Apache
would be duplicated as they would be stored in both Partitions.- Partition1:
_sourceCategory=prod
- Partition2:
_sourceCategory=*/Apache
- Partition1:
Overlapping data between two or more Partitions will count as additional ingest toward your account's quota. See Data Volume Index.
Edit a partition
This section has instructions for editing a partition.
When you create a partition, you specify the routing expression that determines what data is stored in the partition, and a retention period. Optionally, you can enable data forwarding of the partition’s data to an S3 bucket.
About partition editability
You can make some changes to an existing partition:
- You can change the retention period of the partition.
note
By default, Sumo Logic internal partitions like
sumologic_audit_events
,sumologic_volume
, and so on, have the same retention period as the Default Continuous Index. You can change the retention period for any of these internal partitions as desired. - You can change the data forwarding configuration.
- You cannot change the name of partition, routing expression, or reuse a partition name.
- Security partitions can’t be edited. Sumo Logic stores Cloud SIEM Records in seven partitions, one for each Cloud SIEM Record type. The names of the Sumo Logic partitions that contain Cloud SIEM Records begin with the string
sec_record_
. If you have a role that grants you the View Partitions capability, you can view the security partitions in the Sumo Logic UI. Note, however, that no user can edit or remove a security partition.
How to edit a partition
- In the Sumo Logic left navigation bar, go to Manage Data > Logs, then select the Partitions tab.
- Click the row with the partition you want to edit.
- The partition details are displayed on the right side of the page.
- Click Edit to open the pane for editing.
- Retention Period. Enter the number of days you wish to retain the data in the partition, or click Apply the retention period of the Default Continuous Index.
- Data Forwarding. You can configure Data Forwarding, or if Data Forwarding is already configured, modify the configuration. For more information, see Data Forwarding.
Audit logging for routing expression changes
If you change the routing expression for a partition, an event is written to the Audit Event Index with the following details:
EventName
is "PartitionUpdated"Subsystem
is "Partition"Operator
identifies the user that made the change.