# Patent

## Title
Trace and span sampling and analysis for instrumented software

## Abstract

Embodiments of the present disclosure provide for trace and span sampling and analysis for instrumented software. Each span may be annotated with one or more tags that provide context about an executed task, such as a user instrumenting the software, a document involved in a request, an infrastructure element used in servicing a request, etc. A sampler may perform tail-based sampling of traces comprising spans. The sampler may select a portion of the traces having selected features and send them to an analyzer. The analyzer may receive the selected traces and determine whether the selected traces are indicative of configuration problems for the instrumented software. An alert may be generated based on identified configuration problems.

## Background
TECHNICAL FIELD
The present disclosure generally relates to analysis of instrumented software, and more particularly to trace and span sampling and analysis for instrumented software.
BACKGROUND
Software developers monitor different aspects of software they develop by instrumenting the software. These aspects include performance of the software, disk utilization of the software, CPU utilization of the software, errors encountered during execution of the software, significant events encountered during execution of the software, information describing which parts of code are being executed and which parts are not being executed, among others. After development, similar aspects of the software are also monitored during production, such as when software is being executed on a cloud architecture.
Computing operations of the instrumented software can be described by spans and traces. However, communicating all of the spans and traces produced by a software application to an analysis system and storing these spans and traces imposes a serious infrastructure cost. Furthermore, it is unnecessary to transfer and store all emitted spans and traces, since code usually executes quickly and without errors. In prior implementations, traces emitted by a software application were randomly sampled and transmitted for analysis. However, certain types of traces provide more valuable information, and random sampling may not surface these traces. For example, if most traces are error-free, and only a few indicate errors, a random sampling scheme provides a large amount of uninteresting, error-free traces, and may miss the traces that indicate errors.
BRIEF SUMMARY
The subject disclosure provides for systems and methods for trace and span sampling and analysis for instrumented software. Each span may be annotated with one or more tags that provide context about an executed task, such as a user instrumenting the software, a document involved in a request, an infrastructure element used in servicing a request, etc. A sampler may perform tail-based sampling of traces comprising spans. The sampler may select a portion of the traces having selected features and send them to an analyzer. The analyzer may receive the selected traces and determine whether the selected traces are indicative of configuration problems for the instrumented software. An alert may be generated based on identified configuration problems
According to embodiments of the present disclosure, a computer-implemented method for sampling and analyzing spans and traces of instrumented software is provided. The method includes receiving selected traces from a gateway. The selected traces may include spans associated with tags. The selected traces may be selected through tail-based sampling of traces having a selected span, a span with an error, or an overall trace duration. The method also includes comparing durations of a set of similar spans of the selected traces to determine patterns for the tags. The method also includes generating a histogram that represents a distribution of the durations of the set of similar spans. The method also includes providing alerts for tags associated with spans having a duration above a threshold based on the distribution of the durations.
According to one embodiment of the present disclosure, a system for sampling and analyzing spans and traces of instrumented software. The system may include at least one memory having instructions stored thereon. The system may also include at least one processor configured to execute the instructions, wherein the at least one processor is configured to receive selected traces from a gateway. The selected traces may include spans associated with tags. The selected traces may be selected through tail-based sampling of traces having a selected span, a span with an error, or an overall trace duration. The system may also be configured to compare durations of a set of similar spans of the selected traces to determine patterns for the tags. The system may also be configured to generate a histogram that represents a distribution of the durations of the set of similar spans. The system may also be configured to provide alerts for tags associated with spans having a duration above a threshold based on the distribution of the durations.
According to one embodiment of the present disclosure, non-transitory computer-readable storage medium comprising instructions stored thereon, which when executed by one or more processors, cause the one or more processors to perform operations for sampling and analyzing spans and traces of instrumented software, comprising receiving selected traces from a gateway. The selected traces may include spans associated with tags. The selected traces may be selected through tail-based sampling of traces having a selected span, a span with an error, or an overall trace duration. The non-transitory computer-readable storage medium is also configured for comparing durations of a set of similar spans of the selected traces to determine patterns for the tags. The non-transitory computer-readable storage medium is also configured for generating a histogram that represents a distribution of the durations of the set of similar spans. The non-transitory computer-readable storage medium is also configured for providing alerts for tags associated with spans having a duration above a threshold based on the distribution of the durations.
According to one embodiment of the present disclosure, a system is provided that includes means for storing instructions, and means for executing the stored instructions that, when executed by the means, causes the means to perform a method for sampling and analyzing spans and traces of instrumented software. The method includes receiving selected traces from a gateway. The selected traces may include spans associated with tags. The selected traces may be selected through tail-based sampling of traces having a selected span, a span with an error, or an overall trace duration. The method also includes comparing durations of a set of similar spans of the selected traces to determine patterns for the tags. The method also includes generating a histogram that represents a distribution of the durations of the set of similar spans. The method also includes providing alerts for tags associated with spans having a duration above a threshold based on the distribution of the durations.



BRIEF DESCRIPTION OF THE DRAWINGS
The present disclosure is illustrated by way of example, and not limitation, in the figures of the accompanying drawings, in which like reference numerals indicate similar elements and in which:
FIG. 1 is a block diagram of an example networked computer environment, in accordance with example embodiments;
FIG. 2 is a block diagram of an example data intake and query system, in accordance with example embodiments;
FIG. 3 is a block diagram of an example cloud-based data intake and query system, in accordance with example embodiments;
FIG. 4 is a block diagram of an example data intake and query system that performs searches across external data systems, in accordance with example embodiments;
FIG. 5A is a flowchart of an example method that illustrates how indexers process, index, and store data received from forwarders, in accordance with example embodiments;
FIG. 5B is a block diagram of a data structure in which time-stamped event data can be stored in a data store, in accordance with example embodiments;
FIG. 5C provides a visual representation of the manner in which a pipelined search language or query operates, in accordance with example embodiments;
FIG. 6A is a flow diagram of an example method that illustrates how a search head and indexers perform a search query, in accordance with example embodiments;
FIG. 6B provides a visual representation of an example manner in which a pipelined command language or query operates, in accordance with example embodiments;
FIG. 7 shows an overall system environment for reporting based on instrumented software, according to an embodiment of the present disclosure;
FIG. 8 shows an architecture of a system for processing data streams received from instrumented software, according to an embodiment of the present disclosure;
FIG. 9 shows an example of a system for sampling and analyzing spans and traces of instrumented software, according to an embodiment of the present disclosure;
FIG. 10 illustrates a generated histogram for analysis of spans and traces, according to an embodiment of the present disclosure; and
FIG. 11 is a flow diagram illustrative of an embodiment of a process for sampling and analyzing spans and traces of instrumented software, according to embodiments of the present disclosure.



DETAILED DESCRIPTION
Embodiments are described herein according to the following outline:

    
    
        1.0. General Overview
        2.0. Operating Environment
        
            2.1. Host Devices
            2.2. Client Devices
            2.3. Client Device Applications
            2.4. Data Server System
            2.5 Cloud-Based System Overview
            2.6 Searching Externally-Archived Data
            
                2.6.1. ERP Process Features
            
            
            2.7. Data Ingestion
            
                2.7.1. Input
                
                    2.7.2. Parsing
                    2.7.3. Indexing
                
                
            
            
            2.8. Query Processing
            2.9. Pipelined Search Language
            2.10. Field Extraction
        
        
        3.0. Trace and Span Sampling and Analysis for Instrumented Software
        
            3.1. System for Reporting Based on Instrumented Software
            3.2. Sampling Traces and Spans of Instrumented Software
            3.3. Analyzing Traces and Spans of Instrumented Software

1.0. General Overview

        
        
    
    


Modern data centers and other computing environments can comprise anywhere from a few host computer systems to thousands of systems configured to process data, service requests from remote clients, and perform numerous other computational tasks. During operation, various components within these computing environments often generate significant volumes of machine data. Machine data is any data produced by a machine or component in an information technology (IT) environment and that reflects activity in the IT environment. For example, machine data can be raw machine data that is generated by various components in IT environments, such as servers, sensors, routers, mobile devices, Internet of Things (IoT) devices, etc. Machine data can include system logs, network packet data, sensor data, application program data, error logs, stack traces, system performance data, etc. In general, machine data can also include performance data, diagnostic information, and many other types of data that can be analyzed to diagnose performance problems, monitor user interactions, and to derive other insights.
A number of tools are available to analyze machine data. In order to reduce the size of the potentially vast amount of machine data that may be generated, many of these tools typically pre-process the data based on anticipated data-analysis needs. For example, pre-specified data items may be extracted from the machine data and stored in a database to facilitate efficient retrieval and analysis of those data items at search time. However, the rest of the machine data typically is not saved and is discarded during pre-processing. As storage capacity becomes progressively cheaper and more plentiful, there are fewer incentives to discard these portions of machine data and many reasons to retain more of the data.
This plentiful storage capacity is presently making it feasible to store massive quantities of minimally processed machine data for later retrieval and analysis. In general, storing minimally processed machine data and performing analysis operations at search time can provide greater flexibility because it enables an analyst to search all of the machine data, instead of searching only a pre-specified set of data items. This may enable an analyst to investigate different aspects of the machine data that previously were unavailable for analysis.
However, analyzing and searching massive quantities of machine data presents a number of challenges. For example, a data center, servers, or network appliances may generate many different types and formats of machine data (e.g., system logs, network packet data (e.g., wire data, etc.), sensor data, application program data, error logs, stack traces, system performance data, operating system data, virtualization data, etc.) from thousands of different components, which can collectively be very time-consuming to analyze. In another example, mobile devices may generate large amounts of information relating to data accesses, application performance, operating system performance, network performance, etc. There can be millions of mobile devices that report these types of information.
These challenges can be addressed by using an event-based data intake and query system, such as the SPLUNK® ENTERPRISE system developed by Splunk Inc. of San Francisco, Calif. The SPLUNK® ENTERPRISE system is the leading platform for providing real-time operational intelligence that enables organizations to collect, index, and search machine data from various websites, applications, servers, networks, and mobile devices that power their businesses. The data intake and query system is particularly useful for analyzing data which is commonly found in system log files, network data, and other data input sources. Although many of the techniques described herein are explained with reference to a data intake and query system similar to the SPLUNK® ENTERPRISE system, these techniques are also applicable to other types of data systems.
In the data intake and query system, machine data are collected and stored as “events”. An event comprises a portion of machine data and is associated with a specific point in time. The portion of machine data may reflect activity in an IT environment and may be produced by a component of that IT environment, where the events may be searched to provide insight into the IT environment, thereby improving the performance of components in the IT environment. Events may be derived from “time series data,” where the time series data comprises a sequence of data points (e.g., performance measurements from a computer system, etc.) that are associated with successive points in time. In general, each event has a portion of machine data that is associated with a timestamp that is derived from the portion of machine data in the event. A timestamp of an event may be determined through interpolation between temporally proximate events having known timestamps or may be determined based on other configurable rules for associating timestamps with events.
In some instances, machine data can have a predefined format, where data items with specific data formats are stored at predefined locations in the data. For example, the machine data may include data associated with fields in a database table. In other instances, machine data may not have a predefined format (e.g., may not be at fixed, predefined locations), but may have repeatable (e.g., non-random) patterns. This means that some machine data can comprise various data items of different data types that may be stored at different locations within the data. For example, when the data source is an operating system log, an event can include one or more lines from the operating system log containing machine data that includes different types of performance and diagnostic information associated with a specific point in time (e.g., a timestamp).
Examples of components which may generate machine data from which events can be derived include, but are not limited to, web servers, application servers, databases, firewalls, routers, operating systems, and software applications that execute on computer systems, mobile devices, sensors, Internet of Things (IoT) devices, etc. The machine data generated by such data sources can include, for example and without limitation, server log files, activity log files, configuration files, messages, network packet data, performance measurements, sensor measurements, etc.
The data intake and query system uses a flexible schema to specify how to extract information from events. A flexible schema may be developed and redefined as needed. Note that a flexible schema may be applied to events “on the fly,” when it is needed (e.g., at search time, index time, ingestion time, etc.). When the schema is not applied to events until search time, the schema may be referred to as a “late-binding schema.”
During operation, the data intake and query system receives machine data from any type and number of sources (e.g., one or more system logs, streams of network packet data, sensor data, application program data, error logs, stack traces, system performance data, etc.). The system parses the machine data to produce events each having a portion of machine data associated with a timestamp. The system stores the events in a data store. The system enables users to run queries against the stored events to, for example, retrieve events that meet criteria specified in a query, such as criteria indicating certain keywords or having specific values in defined fields. As used herein, the term “field” refers to a location in the machine data of an event containing one or more values for a specific data item. A field may be referenced by a field name associated with the field. As will be described in more detail herein, a field is defined by an extraction rule (e.g., a regular expression) that derives one or more values or a sub-portion of text from the portion of machine data in each event to produce a value for the field for that event. The set of values produced are semantically-related (such as IP address), even though the machine data in each event may be in different formats (e.g., semantically-related values may be in different positions in the events derived from different sources).
As described above, the system stores the events in a data store. The events stored in the data store are field-searchable, where field-searchable herein refers to the ability to search the machine data (e.g., the raw machine data) of an event based on a field specified in search criteria. For example, a search having criteria that specifies a field name “UserID” may cause the system to field-search the machine data of events to identify events that have the field name “UserID.” In another example, a search having criteria that specifies a field name “UserID” with a corresponding field value “12345” may cause the system to field-search the machine data of events to identify events having that field-value pair (e.g., field name “UserID” with a corresponding field value of “12345”). Events are field-searchable using one or more configuration files associated with the events. Each configuration file includes one or more field names, where each field name is associated with a corresponding extraction rule and a set of events to which that extraction rule applies. The set of events to which an extraction rule applies may be identified by metadata associated with the set of events. For example, an extraction rule may apply to a set of events that are each associated with a particular host, source, or source type. When events are to be searched based on a particular field name specified in a search, the system uses one or more configuration files to determine whether there is an extraction rule for that particular field name that applies to each event that falls within the criteria of the search. If so, the event is considered as part of the search results (and additional processing may be performed on that event based on criteria specified in the search). If not, the next event is similarly analyzed, and so on.
As noted above, the data intake and query system utilizes a late-binding schema while performing queries on events. One aspect of a late-binding schema is applying extraction rules to events to extract values for specific fields during search time. More specifically, the extraction rule for a field can include one or more instructions that specify how to extract a value for the field from an event. An extraction rule can generally include any type of instruction for extracting values from events. In some cases, an extraction rule comprises a regular expression, where a sequence of characters forms a search pattern. An extraction rule comprising a regular expression is referred to herein as a regex rule. The system applies a regex rule to an event to extract values for a field associated with the regex rule, where the values are extracted by searching the event for the sequence of characters defined in the regex rule.
In the data intake and query system, a field extractor may be configured to automatically generate extraction rules for certain fields in the events when the events are being created, indexed, or stored, or possibly at a later time. Alternatively, a user may manually define extraction rules for fields using a variety of techniques. In contrast to a conventional schema for a database system, a late-binding schema is not defined at data ingestion time. Instead, the late-binding schema can be developed on an ongoing basis until the time a query is actually executed. This means that extraction rules for the fields specified in a query may be provided in the query itself, or may be located during execution of the query. Hence, as a user learns more about the data in the events, the user can continue to refine the late-binding schema by adding new fields, deleting fields, or modifying the field extraction rules for use the next time the schema is used by the system. Because the data intake and query system maintains the underlying machine data and uses a late-binding schema for searching the machine data, it enables a user to continue investigating and learn valuable insights about the machine data.
In some embodiments, a common field name may be used to reference two or more fields containing equivalent and/or similar data items, even though the fields may be associated with different types of events that possibly have different data formats and different extraction rules. By enabling a common field name to be used to identify equivalent and/or similar fields from different types of events generated by disparate data sources, the system facilitates use of a “common information model” (CIM) across the disparate data sources (further discussed with respect to FIG. 7A).
2.0. Operating Environment
FIG. 1 is a block diagram of an example networked computer environment 100, in accordance with example embodiments. Those skilled in the art would understand that FIG. 1 represents one example of a networked computer system and other embodiments may use different arrangements.
The networked computer system 100 comprises one or more computing devices. These one or more computing devices comprise any combination of hardware and software configured to implement the various logical components described herein. For example, the one or more computing devices may include one or more memories that store instructions for implementing the various components described herein, one or more hardware processors configured to execute the instructions stored in the one or more memories, and various data repositories in the one or more memories for storing data structures utilized and manipulated by the various components.
In some embodiments, one or more client devices 102 are coupled to one or more host devices 106 and a data intake and query system 108 via one or more networks 104. Networks 104 broadly represent one or more LANs, WANs, cellular networks (e.g., LTE, HSPA, 3G, and other cellular technologies), and/or networks using any of wired, wireless, terrestrial microwave, or satellite links, and may include the public Internet.
2.1. Host Devices
In the illustrated embodiment, a system 100 includes one or more host devices 106. Host devices 106 may broadly include any number of computers, virtual machine instances, and/or data centers that are configured to host or execute one or more instances of host applications 114. In general, a host device 106 may be involved, directly or indirectly, in processing requests received from client devices 102. Each host device 106 may comprise, for example, one or more of a network device, a web server, an application server, a database server, etc. A collection of host devices 106 may be configured to implement a network-based service. For example, a provider of a network-based service may configure one or more host devices 106 and host applications 114 (e.g., one or more web servers, application servers, database servers, etc.) to collectively implement the network-based application.
In general, client devices 102 communicate with one or more host applications 114 to exchange information. The communication between a client device 102 and a host application 114 may, for example, be based on the Hypertext Transfer Protocol (HTTP) or any other network protocol. Content delivered from the host application 114 to a client device 102 may include, for example, HTML documents, media content, etc. The communication between a client device 102 and host application 114 may include sending various requests and receiving data packets. For example, in general, a client device 102 or application running on a client device may initiate communication with a host application 114 by making a request for a specific resource (e.g., based on an HTTP request), and the application server may respond with the requested content stored in one or more response packets.
In the illustrated embodiment, one or more of host applications 114 may generate various types of performance data during operation, including event logs, network data, sensor data, and other types of machine data. For example, a host application 114 comprising a web server may generate one or more web server logs in which details of interactions between the web server and any number of client devices 102 is recorded. As another example, a host device 106 comprising a router may generate one or more router logs that record information related to network traffic managed by the router. As yet another example, a host application 114 comprising a database server may generate one or more logs that record information related to requests sent from other host applications 114 (e.g., web servers or application servers) for data managed by the database server.
2.2. Client Devices
Client devices 102 of FIG. 1 represent any computing device capable of interacting with one or more host devices 106 via a network 104. Examples of client devices 102 may include, without limitation, smart phones, tablet computers, handheld computers, wearable devices, laptop computers, desktop computers, servers, portable media players, gaming devices, and so forth. In general, a client device 102 can provide access to different content, for instance, content provided by one or more host devices 106, etc. Each client device 102 may comprise one or more client applications 110, described in more detail in a separate section hereinafter.
2.3. Client Device Applications
In some embodiments, each client device 102 may host or execute one or more client applications 110 that are capable of interacting with one or more host devices 106 via one or more networks 104. For instance, a client application 110 may be or comprise a web browser that a user may use to navigate to one or more websites or other resources provided by one or more host devices 106. As another example, a client application 110 may comprise a mobile application or “app.” For example, an operator of a network-based service hosted by one or more host devices 106 may make available one or more mobile apps that enable users of client devices 102 to access various resources of the network-based service. As yet another example, client applications 110 may include background processes that perform various operations without direct interaction from a user. A client application 110 may include a “plug-in” or “extension” to another application, such as a web browser plug-in or extension.
In some embodiments, a client application 110 may include a monitoring component 112. At a high level, the monitoring component 112 comprises a software component or other logic that facilitates generating performance data related to a client device's operating state, including monitoring network traffic sent and received from the client device and collecting other device and/or application-specific information. Monitoring component 112 may be an integrated component of a client application 110, a plug-in, an extension, or any other type of add-on component. Monitoring component 112 may also be a stand-alone process.
In some embodiments, a monitoring component 112 may be created when a client application 110 is developed, for example, by an application developer using a software development kit (SDK). The SDK may include custom monitoring code that can be incorporated into the code implementing a client application 110. When the code is converted to an executable application, the custom code implementing the monitoring functionality can become part of the application itself.
In some embodiments, an SDK or other code for implementing the monitoring functionality may be offered by a provider of a data intake and query system, such as a system 108. In such cases, the provider of the system 108 can implement the custom code so that performance data generated by the monitoring functionality is sent to the system 108 to facilitate analysis of the performance data by a developer of the client application or other users.
In some embodiments, the custom monitoring code may be incorporated into the code of a client application 110 in a number of different ways, such as the insertion of one or more lines in the client application code that call or otherwise invoke the monitoring component 112. As such, a developer of a client application 110 can add one or more lines of code into the client application 110 to trigger the monitoring component 112 at desired points during execution of the application. Code that triggers the monitoring component may be referred to as a monitor trigger. For instance, a monitor trigger may be included at or near the beginning of the executable code of the client application 110 such that the monitoring component 112 is initiated or triggered as the application is launched, or included at other points in the code that correspond to various actions of the client application, such as sending a network request or displaying a particular interface.
In some embodiments, the monitoring component 112 may monitor one or more aspects of network traffic sent and/or received by a client application 110. For example, the monitoring component 112 may be configured to monitor data packets transmitted to and/or from one or more host applications 114. Incoming and/or outgoing data packets can be read or examined to identify network data contained within the packets, for example, and other aspects of data packets can be analyzed to determine a number of network performance statistics. Monitoring network traffic may enable information to be gathered particular to the network performance associated with a client application 110 or set of applications.
In some embodiments, network performance data refers to any type of data that indicates information about the network and/or network performance. Network performance data may include, for instance, a URL requested, a connection type (e.g., HTTP, HTTPS, etc.), a connection start time, a connection end time, an HTTP status code, request length, response length, request headers, response headers, connection status (e.g., completion, response time(s), failure, etc.), and the like. Upon obtaining network performance data indicating performance of the network, the network performance data can be transmitted to a data intake and query system 108 for analysis.
Upon developing a client application 110 that incorporates a monitoring component 112, the client application 110 can be distributed to client devices 102. Applications generally can be distributed to client devices 102 in any manner, or they can be pre-loaded. In some cases, the application may be distributed to a client device 102 via an application marketplace or other application distribution system. For instance, an application marketplace or other application distribution system might distribute the application to a client device based on a request from the client device to download the application.
Examples of functionality that enables monitoring performance of a client device are described in U.S. patent application Ser. No. 14/524,748, entitled “UTILIZING PACKET HEADERS TO MONITOR NETWORK TRAFFIC IN ASSOCIATION WITH A CLIENT DEVICE”, filed on 27 Oct. 2014, and which is hereby incorporated by reference in its entirety for all purposes.
In some embodiments, the monitoring component 112 may also monitor and collect performance data related to one or more aspects of the operational state of a client application 110 and/or client device 102. For example, a monitoring component 112 may be configured to collect device performance information by monitoring one or more client device operations, or by making calls to an operating system and/or one or more other applications executing on a client device 102 for performance information. Device performance information may include, for instance, a current wireless signal strength of the device, a current connection type and network carrier, current memory performance information, a geographic location of the device, a device orientation, and any other information related to the operational state of the client device.
In some embodiments, the monitoring component 112 may also monitor and collect other device profile information including, for example, a type of client device, a manufacturer and model of the device, versions of various software applications installed on the device, and so forth.
In general, a monitoring component 112 may be configured to generate performance data in response to a monitor trigger in the code of a client application 110 or other triggering application event, as described above, and to store the performance data in one or more data records. Each data record, for example, may include a collection of field-value pairs, each field-value pair storing a particular item of performance data in association with a field for the item. For example, a data record generated by a monitoring component 112 may include a “networkLatency” field (not shown in the Figure) in which a value is stored. This field indicates a network latency measurement associated with one or more network requests. The data record may include a “state” field to store a value indicating a state of a network connection, and so forth for any number of aspects of collected performance data.
2.4. Data Server System
FIG. 2 is a block diagram of an example data intake and query system 108, in accordance with example embodiments. System 108 includes one or more forwarders 204 that receive data from a variety of input data sources 202, and one or more indexers 206 that process and store the data in one or more data stores 208. These forwarders 204 and indexers 206 can comprise separate computer systems, or may alternatively comprise separate processes executing on one or more computer systems.
Each data source 202 broadly represents a distinct source of data that can be consumed by system 108. Examples of a data sources 202 include, without limitation, data files, directories of files, data sent over a network, event logs, registries, etc.
During operation, the forwarders 204 identify which indexers 206 receive data collected from a data source 202 and forward the data to the appropriate indexers. Forwarders 204 can also perform operations on the data before forwarding, including removing extraneous data, detecting timestamps in the data, parsing data, indexing data, routing data based on criteria relating to the data being routed, and/or performing other data transformations.
In some embodiments, a forwarder 204 may comprise a service accessible to client devices 102 and host devices 106 via a network 104. For example, one type of forwarder 204 may be capable of consuming vast amounts of real-time data from a potentially large number of client devices 102 and/or host devices 106. The forwarder 204 may, for example, comprise a computing device which implements multiple data pipelines or “queues” to handle forwarding of network data to indexers 206. A forwarder 204 may also perform many of the functions that are performed by an indexer. For example, a forwarder 204 may perform keyword extractions on raw data or parse raw data to create events. A forwarder 204 may generate time stamps for events. Additionally, or alternatively, a forwarder 204 may perform routing of events to indexers 206. Data store 208 may contain events derived from machine data from a variety of sources all pertaining to the same component in an IT environment, and this data may be produced by the machine in question or by other components in the IT environment.
2.5. Cloud-Based System Overview
The example data intake and query system 108 described in reference to FIG. 2 comprises several system components, including one or more forwarders, indexers, and search heads. In some environments, a user of a data intake and query system 108 may install and configure, on computing devices owned and operated by the user, one or more software applications that implement some or all of these system components. For example, a user may install a software application on server computers owned by the user and configure each server to operate as one or more of a forwarder, an indexer, a search head, etc. This arrangement generally may be referred to as an “on-premises” solution. That is, the system 108 is installed and operates on computing devices directly controlled by the user of the system. Some users may prefer an on-premises solution because it may provide a greater level of control over the configuration of certain aspects of the system (e.g., security, privacy, standards, controls, etc.). However, other users may instead prefer an arrangement in which the user is not directly responsible for providing and managing the computing devices upon which various components of system 108 operate.
In one embodiment, to provide an alternative to an entirely on-premises environment for system 108, one or more of the components of a data intake and query system instead may be provided as a cloud-based service. In this context, a cloud-based service refers to a service hosted by one more computing resources that are accessible to end users over a network, for example, by using a web browser or other application on a client device to interface with the remote computing resources. For example, a service provider may provide a cloud-based data intake and query system by managing computing resources configured to implement various aspects of the system (e.g., forwarders, indexers, search heads, etc.) and by providing access to the system to end users via a network. Typically, a user may pay a subscription or other fee to use such a service. Each subscribing user of the cloud-based service may be provided with an account that enables the user to configure a customized cloud-based system based on the user's preferences.
FIG. 3 illustrates a block diagram of an example cloud-based data intake and query system. Similar to the system of FIG. 2, the networked computer system 300 includes input data sources 202 and forwarders 204. These input data sources and forwarders may be in a subscriber's private computing environment. Alternatively, they might be directly managed by the service provider as part of the cloud service. In the example system 300, one or more forwarders 204 and client devices 302 are coupled to a cloud-based data intake and query system 306 via one or more networks 304. Network 304 broadly represents one or more LANs, WANs, cellular networks, intranetworks, internetworks, etc., using any of wired, wireless, terrestrial microwave, satellite links, etc., and may include the public Internet, and is used by client devices 302 and forwarders 204 to access the system 306. Similar to the system of 38, each of the forwarders 204 may be configured to receive data from an input source and to forward the data to other components of the system 306 for further processing.
In some embodiments, a cloud-based data intake and query system 306 may comprise a plurality of system instances 308. In general, each system instance 308 may include one or more computing resources managed by a provider of the cloud-based system 306 made available to a particular subscriber. The computing resources comprising a system instance 308 may, for example, include one or more servers or other devices configured to implement one or more forwarders, indexers, search heads, and other components of a data intake and query system, similar to system 108. As indicated above, a subscriber may use a web browser or other application of a client device 302 to access a web portal or other interface that enables the subscriber to configure an instance 308.
Providing a data intake and query system as described in reference to system 108 as a cloud-based service presents a number of challenges. Each of the components of a system 108 (e.g., forwarders, indexers, and search heads) may at times refer to various configuration files stored locally at each component. These configuration files typically may involve some level of user configuration to accommodate particular types of data a user desires to analyze and to account for other user preferences. However, in a cloud-based service context, users typically may not have direct access to the underlying computing resources implementing the various system components (e.g., the computing resources comprising each system instance 308) and may desire to make such configurations indirectly, for example, using one or more web-based interfaces. Thus, the techniques and systems described herein for providing user interfaces that enable a user to configure source type definitions are applicable to both on-premises and cloud-based service contexts, or some combination thereof (e.g., a hybrid system where both an on-premises environment, such as SPLUNK® ENTERPRISE, and a cloud-based environment, such as SPLUNK CLOUDTM, are centrally visible).
2.5.1 Containerized, Stateless Cloud-Based System Overview
As shown in the previous figures, various embodiments may refer to a data intake and query system 108 that includes one or more of a search head 210, an indexer 206, and a forwarder 204. In other implementations, data intake and query system 108 may be implemented in a cloud-based system, such as cloud-based data intake and query system 306, as shown in FIG. 3. In some implementations, the cloud-based data intake and query system have a different architecture, but may carry out indexing and searching in a way that is similar to and in some ways functionally equivalent from the perspective of the end user. For example, cloud-based data intake and query system 306 may be re-architected to run in a stateless, containerized environment. In some of these embodiments, cloud-based data intake and query system 306 may be run in a computing cloud provided by a third party, or provided by the operator of the cloud-based data intake and query system 306. This type of cloud-based data intake and query system may have several benefits, including, but not limited to, lossless data ingestion, more robust disaster recovery, and faster or more efficient processing, searching, and indexing. A cloud-based data intake and query system as described in this section may provide separately scalable storage resources and compute resources, or separately scalable search and index resources. Additionally, the cloud-based data intake and query system may allow for applications to be developed on top of the data intake and query system, to extend or enhance functionality, through a gateway layer or one or more Application Programming Interfaces (APIs), which may provide customizable access control or targeted exposure to the workings of the cloud-based data intake and query system 306.
In some embodiments, a cloud-based data intake and query system may include an intake system. Such an intake system can include, but is not limited to an intake buffer, such as Apache Kafka® or Amazon Kinesis®, or an extensible compute layer, such as Apache SparkTM or Apache Flink®. In some embodiments, the search function and the index function may be separated or containerized, so that search functions and index functions may run or scale independently. In some embodiments, data that is indexed may be stored in buckets, which may be stored in a persistent storage once certain bucket requirements have been met, and retrieved as needed for searching. In some embodiments, the search functions and index functions run in stateless containers, which may be coordinated by an orchestration platform. These containerized search and index functions may retrieve data needed to carry out searching and indexing from the buckets or various other services that may also run in containers, or within other components of the orchestration platform. In this manner, loss of a single container, or even multiple containers, does not result in data loss, because the data can be quickly recovered from the various services or components or the buckets in which the data is persisted.
In some embodiments, the cloud-based data intake and query system may implement tenant-based and user-based access control. In some embodiments, the cloud-based data intake and query system may implement an abstraction layer, through a gateway portal, an API, or some combination thereof, to control or limit access to the functionality of the cloud-based data intake and query system. In some embodiments, the cloud-based data intake and query system may be multi-tenant, so that containerized search and indexing may be done across multiple tenants.
2.6. Searching Externally-Archived Data
FIG. 4 shows a block diagram of an example of a data intake and query system 108 that provides transparent search facilities for data systems that are external to the data intake and query system. Such facilities are available in the Splunk® Analytics for Hadoop® system provided by Splunk Inc. of San Francisco, Calif. Splunk® Analytics for Hadoop® represents an analytics platform that enables business and IT teams to rapidly explore, analyze, and visualize data in Hadoop® and NoSQL data stores.
The search head 210 of the data intake and query system receives search requests from one or more client devices 404 over network connections 420. As discussed above, the data intake and query system 108 may reside in an enterprise location, in the cloud, etc. FIG. 4 illustrates that multiple client devices 404a, 404b . . . 404n may communicate with the data intake and query system 108. The client devices 404 may communicate with the data intake and query system using a variety of connections. For example, one client device in FIG. 4 is illustrated as communicating over an Internet (Web) protocol, another client device is illustrated as communicating via a command line interface, and another client device is illustrated as communicating via a software developer kit (SDK).
The search head 210 analyzes the received search request to identify request parameters. If a search request received from one of the client devices 404 references an index maintained by the data intake and query system, then the search head 210 connects to one or more indexers 206 of the data intake and query system for the index referenced in the request parameters. That is, if the request parameters of the search request reference an index, then the search head accesses the data in the index via the indexer. The data intake and query system 108 may include one or more indexers 206, depending on system access resources and requirements. As described further below, the indexers 206 retrieve data from their respective local data stores 208 as specified in the search request. The indexers and their respective data stores can comprise one or more storage devices and typically reside on the same system, though they may be connected via a local network connection.
If the request parameters of the received search request reference an external data collection, which is not accessible to the indexers 206 or under the management of the data intake and query system, then the search head 210 can access the external data collection through an External Result Provider (ERP) process 410. An external data collection may be referred to as a “virtual index” (plural, “virtual indices”). An ERP process provides an interface through which the search head 210 may access virtual indices.
Thus, a search reference to an index of the system relates to a locally stored and managed data collection. In contrast, a search reference to a virtual index relates to an externally stored and managed data collection, which the search head may access through one or more ERP processes 410, 412. FIG. 4 shows two ERP processes 410, 412 that connect to respective remote (external) virtual indices, which are indicated as a Hadoop or another system 414 (e.g., Amazon S3, Amazon EMR, other Hadoop® Compatible File Systems (HCFS), etc.) and a relational database management system (RDBMS) 416. Other virtual indices may include other file organizations and protocols, such as Structured Query Language (SQL) and the like. The ellipses between the ERP processes 410, 412 indicate optional additional ERP processes of the data intake and query system 108. An ERP process may be a computer process that is initiated or spawned by the search head 210 and is executed by the search data intake and query system 108. Alternatively, or additionally, an ERP process may be a process spawned by the search head 210 on the same or different host system as the search head 210 resides.
The search head 210 may spawn a single ERP process in response to multiple virtual indices referenced in a search request, or the search head may spawn different ERP processes for different virtual indices. Generally, virtual indices that share common data configurations or protocols may share ERP processes. For example, all search query references to a Hadoop file system may be processed by the same ERP process, if the ERP process is suitably configured. Likewise, all search query references to a SQL database may be processed by the same ERP process. In addition, the search head may provide a common ERP process for common external data source types (e.g., a common vendor may utilize a common ERP process, even if the vendor includes different data storage system types, such as Hadoop and SQL). Common indexing schemes also may be handled by common ERP processes, such as flat text files or Weblog files.
The search head 210 determines the number of ERP processes to be initiated via the use of configuration parameters that are included in a search request message. Generally, there is a one-to-many relationship between an external results provider “family” and ERP processes. There is also a one-to-many relationship between an ERP process and corresponding virtual indices that are referred to in a search request. For example, using RDBMS, assume two independent instances of such a system by one vendor, such as one RDBMS for production and another RDBMS used for development. In such a situation, it is likely preferable (but optional) to use two ERP processes to maintain the independent operation as between production and development data. Both of the ERPs, however, will belong to the same family, because the two RDBMS system types are from the same vendor.
The ERP processes 410, 412 receive a search request from the search head 210. The search head may optimize the received search request for execution at the respective external virtual index. Alternatively, the ERP process may receive a search request as a result of analysis performed by the search head or by a different system process. The ERP processes 410, 412 can communicate with the search head 210 via conventional input/output routines (e.g., standard in/standard out, etc.). In this way, the ERP process receives the search request from a client device such that the search request may be efficiently executed at the corresponding external virtual index.
The ERP processes 410, 412 may be implemented as a process of the data intake and query system. Each ERP process may be provided by the data intake and query system, or may be provided by process or application providers who are independent of the data intake and query system. Each respective ERP process may include an interface application installed at a computer of the external result provider that ensures proper communication between the search support system and the external result provider. The ERP processes 410, 412 generate appropriate search requests in the protocol and syntax of the respective virtual indices 414, 416, each of which corresponds to the search request received by the search head 210. Upon receiving search results from their corresponding virtual indices, the respective ERP process passes the result to the search head 210, which may return or display the results or a processed set of results based on the returned results to the respective client device.
Client devices 404 may communicate with the data intake and query system 108 through a network interface 420, e.g., one or more LANs, WANs, cellular networks, intranetworks, and/or internetworks using any of wired, wireless, terrestrial microwave, satellite links, etc., and may include the public Internet.
The analytics platform utilizing the External Result Provider process described in more detail in U.S. Pat. No. 8,738,629, entitled “EXTERNAL RESULT PROVIDED PROCESS FOR RETRIEVING DATA STORED USING A DIFFERENT CONFIGURATION OR PROTOCOL”, issued on 27 May 2014, U.S. Pat. No. 8,738,587, entitled “PROCESSING A SYSTEM SEARCH REQUEST BY RETRIEVING RESULTS FROM BOTH A NATIVE INDEX AND A VIRTUAL INDEX”, issued on 25 Jul. 2013, U.S. patent application Ser. No. 14/266,832, entitled “PROCESSING A SYSTEM SEARCH REQUEST ACROSS DISPARATE DATA COLLECTION SYSTEMS”, filed on 1 May 2014, and U.S. Pat. No. 9,514,189, entitled “PROCESSING A SYSTEM SEARCH REQUEST INCLUDING EXTERNAL DATA SOURCES”, issued on 6 Dec. 2016, each of which is hereby incorporated by reference in its entirety for all purposes.
2.6.1. ERP Process Features
The ERP processes described above may include two operation modes: a streaming mode and a reporting mode. The ERP processes can operate in streaming mode only, in reporting mode only, or in both modes simultaneously. Operating in both modes simultaneously is referred to as mixed mode operation. In a mixed mode operation, the ERP at some point can stop providing the search head with streaming results and only provide reporting results thereafter, or the search head at some point may start ignoring streaming results it has been using and only use reporting results thereafter.
The streaming mode returns search results in real time, with minimal processing, in response to the search request. The reporting mode provides results of a search request with processing of the search results prior to providing them to the requesting search head, which in turn provides results to the requesting client device. ERP operation with such multiple modes provides greater performance flexibility with regard to report time, search latency, and resource utilization.
In a mixed mode operation, both streaming mode and reporting mode are operating simultaneously. The streaming mode results (e.g., the machine data obtained from the external data source) are provided to the search head, which can then process the results data (e.g., break the machine data into events, timestamp it, filter it, etc.) and integrate the results data with the results data from other external data sources, and/or from data stores of the search head. The search head performs such processing and can immediately start returning interim (streaming mode) results to the user at the requesting client device; simultaneously, the search head is waiting for the ERP process to process the data it is retrieving from the external data source as a result of the concurrently executing reporting mode.
In some instances, the ERP process initially operates in a mixed mode, such that the streaming mode operates to enable the ERP quickly to return interim results (e.g., some of the machined data or unprocessed data necessary to respond to a search request) to the search head, enabling the search head to process the interim results and begin providing to the client or search requester interim results that are responsive to the query. Meanwhile, in this mixed mode, the ERP also operates concurrently in reporting mode, processing portions of machine data in a manner responsive to the search query. Upon determining that it has results from the reporting mode available to return to the search head, the ERP may halt processing in the mixed mode at that time (or some later time) by stopping the return of data in streaming mode to the search head and switching to reporting mode only. The ERP at this point starts sending interim results in reporting mode to the search head, which in turn may then present this processed data responsive to the search request to the client or search requester. Typically, the search head switches from using results from the ERP's streaming mode of operation to results from the ERP's reporting mode of operation when the higher bandwidth results from the reporting mode outstrip the amount of data processed by the search head in the streaming mode of ERP operation.
A reporting mode may have a higher bandwidth because the ERP does not have to spend time transferring data to the search head for processing all the machine data. In addition, the ERP may optionally direct another processor to do the processing.
The streaming mode of operation does not need to be stopped to gain the higher bandwidth benefits of a reporting mode; the search head could simply stop using the streaming mode results—and start using the reporting mode results—when the bandwidth of the reporting mode has caught up with or exceeded the amount of bandwidth provided by the streaming mode. Thus, a variety of triggers and ways to accomplish a search head's switch from using streaming mode results to using reporting mode results may be appreciated by one skilled in the art.
The reporting mode can involve the ERP process (or an external system) performing event breaking, time stamping, filtering of events to match the search query request, and calculating statistics on the results. The user can request particular types of data, such as if the search query itself involves types of events, or the search request may ask for statistics on data, such as on events that meet the search request. In either case, the search head understands the query language used in the received query request, which may be a proprietary language. One exemplary query language is Splunk Processing Language (SPL) developed by the assignee of the application, Splunk Inc. The search head typically understands how to use that language to obtain data from the indexers, which store data in a format used by the SPLUNK® Enterprise system.
The ERP processes support the search head, as the search head is not ordinarily configured to understand the format in which data is stored in external data sources such as Hadoop or SQL data systems. Rather, the ERP process performs that translation from the query submitted in the search support system's native format (e.g., SPL if SPLUNK® ENTERPRISE is used as the search support system) to a search query request format that will be accepted by the corresponding external data system. The external data system typically stores data in a different format from that of the search support system's native index format, and it utilizes a different query language (e.g., SQL or MapReduce, rather than SPL or the like).
As noted, the ERP process can operate in the streaming mode alone. After the ERP process has performed the translation of the query request and received raw results from the streaming mode, the search head can integrate the returned data with any data obtained from local data sources (e.g., native to the search support system), other external data sources, and other ERP processes (if such operations were required to satisfy the terms of the search query). An advantage of mixed mode operation is that, in addition to streaming mode, the ERP process is also executing concurrently in reporting mode. Thus, the ERP process (rather than the search head) is processing query results (e.g., performing event breaking, timestamping, filtering, possibly calculating statistics if required to be responsive to the search query request, etc.). It should be apparent to those skilled in the art that additional time is needed for the ERP process to perform the processing in such a configuration. Therefore, the streaming mode will allow the search head to start returning interim results to the user at the client device before the ERP process can complete sufficient processing to start returning any search results. The switchover between streaming and reporting mode happens when the ERP process determines that the switchover is appropriate, such as when the ERP process determines it can begin returning meaningful results from its reporting mode.
The operation described above illustrates the source of operational latency: streaming mode has low latency (immediate results) and usually has relatively low bandwidth (fewer results can be returned per unit of time). In contrast, the concurrently running reporting mode has relatively high latency (it has to perform a lot more processing before returning any results) and usually has relatively high bandwidth (more results can be processed per unit of time). For example, when the ERP process does begin returning report results, it returns more processed results than in the streaming mode, because, e.g., statistics only need to be calculated to be responsive to the search request. That is, the ERP process doesn't have to take time to first return machine data to the search head. As noted, the ERP process could be configured to operate in streaming mode alone and return just the machine data for the search head to process in a way that is responsive to the search request. Alternatively, the ERP process can be configured to operate in the reporting mode only. Also, the ERP process can be configured to operate in streaming mode and reporting mode concurrently, as described, with the ERP process stopping the transmission of streaming results to the search head when the concurrently running reporting mode has caught up and started providing results. The reporting mode does not require the processing of all machine data that is responsive to the search query request before the ERP process starts returning results; rather, the reporting mode usually performs processing of chunks of events and returns the processing results to the search head for each chunk.
For example, an ERP process can be configured to merely return the contents of a search result file verbatim, with little or no processing of results. That way, the search head performs all processing (such as parsing byte streams into events, filtering, etc.). The ERP process can be configured to perform additional intelligence, such as analyzing the search request and handling all the computation that a native search indexer process would otherwise perform. In this way, the configured ERP process provides greater flexibility in features while operating according to desired preferences, such as response latency and resource requirements.
2.7. Data Ingestion
FIG. 5A is a flow chart of an example method that illustrates how indexers process, index, and store data received from forwarders, in accordance with example embodiments. The data flow illustrated in FIG. 5A is provided for illustrative purposes only; those skilled in the art would understand that one or more of the steps of the processes illustrated in FIG. 5A may be removed or that the ordering of the steps may be changed. Furthermore, for the purposes of illustrating a clear example, one or more particular system components are described in the context of performing various operations during each of the data flow stages. For example, a forwarder is described as receiving and processing machine data during an input phase; an indexer is described as parsing and indexing machine data during parsing and indexing phases; and a search head is described as performing a search query during a search phase. However, other system arrangements and distributions of the processing steps across system components may be used.
2.7.1. Input
At block 502, a forwarder receives data from an input source, such as a data source 202 shown in FIG. 2. A forwarder initially may receive the data as a raw data stream generated by the input source. For example, a forwarder may receive a data stream from a log file generated by an application server, from a stream of network data from a network device, or from any other source of data. In some embodiments, a forwarder receives the raw data and may segment the data stream into “blocks”, possibly of a uniform data size, to facilitate subsequent processing steps.
At block 504, a forwarder or other system component annotates each block generated from the raw data with one or more metadata fields. These metadata fields may, for example, provide information related to the data block as a whole and may apply to each event that is subsequently derived from the data in the data block. For example, the metadata fields may include separate fields specifying each of a host, a source, and a source type related to the data block. A host field may contain a value identifying a host name or IP address of a device that generated the data. A source field may contain a value identifying a source of the data, such as a pathname of a file or a protocol and port related to received network data. A source type field may contain a value specifying a particular source type label for the data. Additional metadata fields may also be included during the input phase, such as a character encoding of the data, if known, and possibly other values that provide information relevant to later processing steps. In some embodiments, a forwarder forwards the annotated data blocks to another system component (typically an indexer) for further processing.
The data intake and query system allows forwarding of data from one data intake and query instance to another, or even to a third-party system. The data intake and query system can employ different types of forwarders in a configuration.
In some embodiments, a forwarder may contain the essential components needed to forward data. A forwarder can gather data from a variety of inputs and forward the data to an indexer for indexing and searching. A forwarder can also tag metadata (e.g., source, source type, host, etc.).
In some embodiments, a forwarder has the capabilities of the aforementioned forwarder as well as additional capabilities. The forwarder can parse data before forwarding the data (e.g., can associate a time stamp with a portion of data and create an event, etc.) and can route data based on criteria such as source or type of event. The forwarder can also index data locally while forwarding the data to another indexer.
2.7.2. Components and Protocols for Receiving Data
In various embodiments, forwarders 204 may communicate with indexers 206 via one or more data transfer protocols. Although any number of data transfer protocols may be used, in some implementations, forwarders 204 communicate with indexers 206 through use of a binary protocol referred to as “S2S” or “Splunk-to-Splunk” protocol. S2S protocol specifies that, after the forwarder 204 and indexer 206 connect over a network via a port, e.g., a Transmission Control Protocol (TCP) port, the forwarder 204 sends a message to the indexer 206 describing the S2S protocol features it would like to use. In response, the indexer 206 responds with a message that describes the S2S protocol features that have been accepted for network communication with the forwarder 204, based on the feature request description from forwarder 204. These requests may include, for example, per-event ACK (acknowledgement) payloads, or various compression algorithms used to reduce the size of events to be transferred. After the forwarder 204 receives notification of the features that will be used in communicating with indexer 206, the forwarder 204 begins sending serialized objects in binary format. The objects may include one or more events and/or various metadata associated with the events. The objects may be compressed using various compression algorithms, or otherwise packaged, reduced, or encrypted. In some embodiments, each event may be compressed separately, and in other embodiments, packages of events may be compressed together. In other embodiments, the S2S protocol may be used by forwarders 204 to send information to any receiving component of the data intake and query system 108, including, e.g., components of the cloud-based data intake and query system 306.
In various embodiments, other data transfer protocols may be used to transmit data from the one or more data sources 102 into the data intake and query system. Specifically, in various embodiments, it may be advantageous to set up protocols for transmitting data into the data intake and query system without requiring the use of forwarders 204. Thus, there are embodiments in which the HyperText Transfer Protocol (HTTP) can be used to transmit data from data sources 102 to the data intake and query system. In order to facilitate use of HTTP to transmit this data, various embodiments of data intake and query system 108 may include an HTTP Event Collector, or “HEC.” The HEC is an agent that is part of the data intake and query system 108, and which can receive information sent from data sources 102. Use of the HEC has the advantage of generally not requiring any additional components, either hardware or software, to be added to or installed on the data sources 102, beyond what is required to send messages using HTTP “POST” commands.
In various embodiments, the HEC operates at the data intake and query system 108 to receive HTTP POST requests from various sources, e.g., data sources 102. The HEC begins the process through generation of tokens, which can be distributed to the data sources 102 through a variety of known methods, both manual and automated. A data source 102 can access the HEC by sending an HEC token to the HEC, e.g., through the authentication header of an HTTP POST request. Once this token is recognized by the HEC, the data source 102 can send data in any format to the HEC, using the HTTP POST command Although any type of data can be sent to the HEC through an HTTP POST command, in various implementations, event data may be submitted, either in raw text format, or in JavaScript Object Notation (JSON) format. In various implementations, events sent in the JSON format may include metadata, such as one or more of a timestamp of the event, a host name of the event, a source of the event, and a sourcetype of the event. Upon receipt of the data from the HTTP POST command, the HEC may send the data to an indexer 206, or, for example, in a cloud-based data intake and query system 306, place the data in an ingestion buffer, such as a message-oriented pub/sub or a stream processor.
2.7.3. Parsing
At block 506, an indexer receives data blocks from a forwarder and parses the data to organize the data into events. In some embodiments, to organize the data into events, an indexer may determine a source type associated with each data block (e.g., by extracting a source type label from the metadata fields associated with the data block, etc.) and refer to a source type configuration corresponding to the identified source type. The source type definition may include one or more properties that indicate to the indexer to automatically determine the boundaries within the received data that indicate the portions of machine data for events. In general, these properties may include regular expression-based rules or delimiter rules where, for example, event boundaries may be indicated by predefined characters or character strings. These predefined characters may include punctuation marks or other special characters including, for example, carriage returns, tabs, spaces, line breaks, etc. If a source type for the data is unknown to the indexer, an indexer may infer a source type for the data by examining the structure of the data. Then, the indexer can apply an inferred source type definition to the data to create the events.
At block 508, the indexer determines a timestamp for each event. Similar to the process for parsing machine data, an indexer may again refer to a source type definition associated with the data to locate one or more properties that indicate instructions for determining a timestamp for each event. The properties may, for example, instruct an indexer to extract a time value from a portion of data for the event, to interpolate time values based on timestamps associated with temporally proximate events, to create a timestamp based on a time the portion of machine data was received or generated, to use the timestamp of a previous event, or use any other rules for determining timestamps.
At block 510, the indexer associates with each event one or more metadata fields including a field containing the timestamp determined for the event. In some embodiments, a timestamp may be included in the metadata fields. These metadata fields may include any number of “default fields” that are associated with all events, and may also include one more custom fields as defined by a user. Similar to the metadata fields associated with the data blocks at block 504, the default metadata fields associated with each event may include a host, source, and source type field including or in addition to a field storing the timestamp.
At block 512, an indexer may optionally apply one or more transformations to data included in the events created at block 506. For example, such transformations can include removing a portion of an event (e.g., a portion used to define event boundaries, extraneous characters from the event, other extraneous text, etc.), masking a portion of an event (e.g., masking a credit card number), removing redundant portions of an event, etc. The transformations applied to events may, for example, be specified in one or more configuration files and referenced by one or more source type definitions.
FIG. 5C illustrates an illustrative example of machine data can be stored in a data store in accordance with various disclosed embodiments. In other embodiments, machine data can be stored in a flat file in a corresponding bucket with an associated index file, such as a time series index or “TSIDX.” As such, the depiction of machine data and associated metadata as rows and columns in the table of FIG. 5C is merely illustrative and is not intended to limit the data format in which the machine data and metadata is stored in various embodiments described herein. In one particular embodiment, machine data can be stored in a compressed or encrypted formatted. In such embodiments, the machine data can be stored with or be associated with data that describes the compression or encryption scheme with which the machine data is stored. The information about the compression or encryption scheme can be used to decompress or decrypt the machine data, and any metadata with which it is stored, at search time.
As mentioned above, certain metadata, e.g., host 536, source 537, source type 538 and timestamps 535 can be generated for each event, and associated with a corresponding portion of machine data 539 when storing the event data in a data store, e.g., data store 208. Any of the metadata can be extracted from the corresponding machine data, or supplied or defined by an entity, such as a user or computer system. The metadata fields can become part of or stored with the event. Note that while the time-stamp metadata field can be extracted from the raw data of each event, the values for the other metadata fields may be determined by the indexer based on information it receives pertaining to the source of the data separate from the machine data.
While certain default or user-defined metadata fields can be extracted from the machine data for indexing purposes, all the machine data within an event can be maintained in its original condition. As such, in embodiments in which the portion of machine data included in an event is unprocessed or otherwise unaltered, it is referred to herein as a portion of raw machine data. In other embodiments, the port of machine data in an event can be processed or otherwise altered. As such, unless certain information needs to be removed for some reasons (e.g. extraneous information, confidential information), all the raw machine data contained in an event can be preserved and saved in its original form. Accordingly, the data store in which the event records are stored is sometimes referred to as a “raw record data store.” The raw record data store contains a record of the raw event data tagged with the various default fields.
In FIG. 5C, the first three rows of the table represent events 531, 532, and 533 and are related to a server access log that records requests from multiple clients processed by a server, as indicated by entry of “access.log” in the source column 536.
In the example shown in FIG. 5C, each of the events 531-533 is associated with a discrete request made from a client device. The raw machine data generated by the server and extracted from a server access log can include the IP address of the client 540, the user id of the person requesting the document 541, the time the server finished processing the request 542, the request line from the client 543, the status code returned by the server to the client 545, the size of the object returned to the client (in this case, the gif file requested by the client) 546 and the time spent to serve the request in microseconds 544. As seen in FIG. 5C, all the raw machine data retrieved from the server access log is retained and stored as part of the corresponding events, 531-533 in the data store.
Event 534 is associated with an entry in a server error log, as indicated by “error.log” in the source column 537 that records errors that the server encountered when processing a client request. Similar to the events related to the server access log, all the raw machine data in the error log file pertaining to event 534 can be preserved and stored as part of the event 534.
Saving minimally processed or unprocessed machine data in a data store associated with metadata fields in the manner similar to that shown in FIG. 5C is advantageous because it allows search of all the machine data at search time instead of searching only previously specified and identified fields or field-value pairs. As mentioned above, because data structures used by various embodiments of the present disclosure maintain the underlying raw machine data and use a late-binding schema for searching the raw machines data, it enables a user to continue investigating and learn valuable insights about the raw data. In other words, the user is not compelled to know about all the fields of information that will be needed at data ingestion time. As a user learns more about the data in the events, the user can continue to refine the late-binding schema by defining new extraction rules, or modifying or deleting existing extraction rules used by the system.
2.7.4. Indexing
At blocks 514 and 516, an indexer can optionally generate a keyword index to facilitate fast keyword searching for events. To build a keyword index, at block 514, the indexer identifies a set of keywords in each event. At block 516, the indexer includes the identified keywords in an index, which associates each stored keyword with reference pointers to events containing that keyword (or to locations within events where that keyword is located, other location identifiers, etc.). When an indexer subsequently receives a keyword-based query, the indexer can access the keyword index to quickly identify events containing the keyword.
In some embodiments, the keyword index may include entries for field name-value pairs found in events, where a field name-value pair can include a pair of keywords connected by a symbol, such as an equals sign or colon. This way, events containing these field name-value pairs can be quickly located. In some embodiments, fields can automatically be generated for some or all of the field names of the field name-value pairs at the time of indexing. For example, if the string “dest=10.0.1.2” is found in an event, a field named “dest” may be created for the event, and assigned a value of “10.0.1.2”.
At block 518, the indexer stores the events with an associated timestamp in a data store 208. Timestamps enable a user to search for events based on a time range. In some embodiments, the stored events are organized into “buckets,” where each bucket stores events associated with a specific time range based on the timestamps associated with each event. This improves time-based searching, as well as allows for events with recent timestamps, which may have a higher likelihood of being accessed, to be stored in a faster memory to facilitate faster retrieval. For example, buckets containing the most recent events can be stored in flash memory rather than on a hard disk. In some embodiments, each bucket may be associated with an identifier, a time range, and a size constraint.
Each indexer 206 may be responsible for storing and searching a subset of the events contained in a corresponding data store 208. By distributing events among the indexers and data stores, the indexers can analyze events for a query in parallel. For example, using map-reduce techniques, each indexer returns partial responses for a subset of events to a search head that combines the results to produce an answer for the query. By storing events in buckets for specific time ranges, an indexer may further optimize the data retrieval process by searching buckets corresponding to time ranges that are relevant to a query. In some embodiments, each bucket may be associated with an identifier, a time range, and a size constraint. In certain embodiments, a bucket can correspond to a file system directory and the machine data, or events, of a bucket can be stored in one or more files of the file system directory. The file system directory can include additional files, such as one or more inverted indexes, high performance indexes, permissions files, configuration files, etc.
In some embodiments, each indexer has a home directory and a cold directory. The home directory of an indexer stores hot buckets and warm buckets, and the cold directory of an indexer stores cold buckets. A hot bucket is a bucket that is capable of receiving and storing events. A warm bucket is a bucket that can no longer receive events for storage but has not yet been moved to the cold directory. A cold bucket is a bucket that can no longer receive events and may be a bucket that was previously stored in the home directory. The home directory may be stored in faster memory, such as flash memory, as events may be actively written to the home directory, and the home directory may typically store events that are more frequently searched and thus are accessed more frequently. The cold directory may be stored in slower and/or larger memory, such as a hard disk, as events are no longer being written to the cold directory, and the cold directory may typically store events that are not as frequently searched and thus are accessed less frequently. In some embodiments, an indexer may also have a quarantine bucket that contains events having potentially inaccurate information, such as an incorrect time stamp associated with the event or a time stamp that appears to be an unreasonable time stamp for the corresponding event. The quarantine bucket may have events from any time range; as such, the quarantine bucket may always be searched at search time. Additionally, an indexer may store old, archived data in a frozen bucket that is not capable of being searched at search time. In some embodiments, a frozen bucket may be stored in slower and/or larger memory, such as a hard disk, and may be stored in offline and/or remote storage.
Moreover, events and buckets can also be replicated across different indexers and data stores to facilitate high availability and disaster recovery as described in U.S. Pat. No. 9,130,971, entitled “SITE-BASED SEARCH AFFINITY”, issued on 8 Sep. 2015, and in U.S. patent Ser. No. 14/266,817, entitled “MULTI-SITE CLUSTERING”, issued on 1 Sep. 2015, each of which is hereby incorporated by reference in its entirety for all purposes.
FIG. 5B is a block diagram of an example data store 501 that includes a directory for each index (or partition) that contains a portion of data managed by an indexer. FIG. 5B further illustrates details of an embodiment of an inverted index 507B and an event reference array 515 associated with inverted index 507B.
The data store 501 can correspond to a data store 208 that stores events managed by an indexer 206 or can correspond to a different data store associated with an indexer 206. In the illustrated embodiment, the data store 501 includes a _main directory 503 associated with a _main index and a _test directory 505 associated with a _test index. However, the data store 501 can include fewer or more directories. In some embodiments, multiple indexes can share a single directory or all indexes can share a common directory. Additionally, although illustrated as a single data store 501, it will be understood that the data store 501 can be implemented as multiple data stores storing different portions of the information shown in FIG. 5B. For example, a single index or partition can span multiple directories or multiple data stores, and can be indexed or searched by multiple corresponding indexers.
In the illustrated embodiment of FIG. 5B, the index-specific directories 503 and 505 include inverted indexes 507A, 507B and 509A, 509B, respectively. The inverted indexes 507A . . . 507B, and 509A . . . 509B can be keyword indexes or field-value pair indexes described herein and can include less or more information that depicted in FIG. 5B.
In some embodiments, the inverted index 507A . . . 507B, and 509A . . . 509B can correspond to a distinct time-series bucket that is managed by the indexer 206 and that contains events corresponding to the relevant index (e.g., _main index, _test index). As such, each inverted index can correspond to a particular range of time for an index. Additional files, such as high performance indexes for each time-series bucket of an index, can also be stored in the same directory as the inverted indexes 507A . . . 507B, and 509A . . . 509B. In some embodiments inverted index 507A . . . 507B, and 509A . . . 509B can correspond to multiple time-series buckets or inverted indexes 507A . . . 507B, and 509A . . . 509B can correspond to a single time-series bucket.
Each inverted index 507A . . . 507B, and 509A . . . 509B can include one or more entries, such as keyword (or token) entries or field-value pair entries. Furthermore, in certain embodiments, the inverted indexes 507A . . . 507B, and 509A . . . 509B can include additional information, such as a time range 523 associated with the inverted index or an index identifier 525 identifying the index associated with the inverted index 507A . . . 507B, and 509A . . . 509B. However, each inverted index 507A . . . 507B, and 509A . . . 509B can include less or more information than depicted.
Token entries, such as token entries 511 illustrated in inverted index 507B, can include a token 511A (e.g., “error,” “itemID,” etc.) and event references 511B indicative of events that include the token. For example, for the token “error,” the corresponding token entry includes the token “error” and an event reference, or unique identifier, for each event stored in the corresponding time-series bucket that includes the token “error.” In the illustrated embodiment of FIG. 5B, the error token entry includes the identifiers 3, 5, 6, 8, 11, and 12 corresponding to events managed by the indexer 206 and associated with the index _main 503 that are located in the time-series bucket associated with the inverted index 507B.
In some cases, some token entries can be default entries, automatically determined entries, or user specified entries. In some embodiments, the indexer 206 can identify each word or string in an event as a distinct token and generate a token entry for it. In some cases, the indexer 206 can identify the beginning and ending of tokens based on punctuation, spaces, as described in greater detail herein. In certain cases, the indexer 206 can rely on user input or a configuration file to identify tokens for token entries 511, etc. It will be understood that any combination of token entries can be included as a default, automatically determined, and/or included based on user-specified criteria.
Similarly, field-value pair entries, such as field-value pair entries 513 shown in inverted index 507B, can include a field-value pair 513A and event references 513B indicative of events that include a field value that corresponds to the field-value pair. For example, for a field-value pair sourcetype::sendmail, a field-value pair entry would include the field-value pair sourcetype::sendmail and a unique identifier, or event reference, for each event stored in the corresponding time-series bucket that includes a sendmail sourcetype.
In some cases, the field-value pair entries 513 can be default entries, automatically determined entries, or user specified entries. As a non-limiting example, the field-value pair entries for the fields host, source, sourcetype can be included in the inverted indexes 507A . . . 507B, and 509A . . . 509B as a default. As such, all of the inverted indexes 507A . . . 507B, and 509A . . . 509B can include field-value pair entries for the fields host, source, sourcetype. As yet another non-limiting example, the field-value pair entries for the IP_address field can be user specified and may only appear in the inverted index 507B based on user-specified criteria. As another non-limiting example, as the indexer indexes the events, it can automatically identify field-value pairs and create field-value pair entries. For example, based on the indexers review of events, it can identify IP_address as a field in each event and add the IP_address field-value pair entries to the inverted index 507B. It will be understood that any combination of field-value pair entries can be included as a default, automatically determined, or included based on user-specified criteria.
Each unique identifier 517, or event reference, can correspond to a unique event located in the time series bucket. However, the same event reference can be located in multiple entries. For example, if an event has a sourcetype splunkd, host www1 and token “warning,” then the unique identifier for the event will appear in the field-value pair entries sourcetype::splunkd and host::www1, as well as the token entry “warning.” With reference to the illustrated embodiment of FIG. 5B and the event that corresponds to the event reference 3, the event reference 3 is found in the field-value pair entries 513 host::hostA, source::sourceB, sourcetype::sourcetypeA, and IP_address::91.205.189.15 indicating that the event corresponding to the event references is from hostA, sourceB, of sourcetypeA, and includes 91.205.189.15 in the event data.
For some fields, the unique identifier is located in only one field-value pair entry for a particular field. For example, the inverted index may include four sourcetype field-value pair entries corresponding to four different sourcetypes of the events stored in a bucket (e.g., sourcetypes: sendmail, splunkd, web_access, and web_service). Within those four sourcetype field-value pair entries, an identifier for a particular event may appear in only one of the field-value pair entries. With continued reference to the example illustrated embodiment of FIG. 5B, since the event reference 7 appears in the field-value pair entry sourcetype::sourcetypeA, then it does not appear in the other field-value pair entries for the sourcetype field, including sourcetype::sourcetypeB, sourcetype::sourcetypeC, and sourcetype::sourcetypeD.
The event references 517 can be used to locate the events in the corresponding bucket. For example, the inverted index can include, or be associated with, an event reference array 515. The event reference array 515 can include an array entry 517 for each event reference in the inverted index 507B. Each array entry 517 can include location information 519 of the event corresponding to the unique identifier (non-limiting example: seek address of the event), a timestamp 521 associated with the event, or additional information regarding the event associated with the event reference, etc.
For each token entry 511 or field-value pair entry 513, the event reference 501B or unique identifiers can be listed in chronological order or the value of the event reference can be assigned based on chronological data, such as a timestamp associated with the event referenced by the event reference. For example, the event reference 1 in the illustrated embodiment of FIG. 5B can correspond to the first-in-time event for the bucket, and the event reference 12 can correspond to the last-in-time event for the bucket. However, the event references can be listed in any order, such as reverse chronological order, ascending order, descending order, or some other order, etc. Further, the entries can be sorted. For example, the entries can be sorted alphabetically (collectively or within a particular group), by entry origin (e.g., default, automatically generated, user-specified, etc.), by entry type (e.g., field-value pair entry, token entry, etc.), or chronologically by when added to the inverted index, etc. In the illustrated embodiment of FIG. 5B, the entries are sorted first by entry type and then alphabetically.
As a non-limiting example of how the inverted indexes 507A . . . 507B, and 509A . . . 509B can be used during a data categorization request command, the indexers can receive filter criteria indicating data that is to be categorized and categorization criteria indicating how the data is to be categorized. Example filter criteria can include, but is not limited to, indexes (or partitions), hosts, sources, sourcetypes, time ranges, field identifier, keywords, etc.
Using the filter criteria, the indexer identifies relevant inverted indexes to be searched. For example, if the filter criteria includes a set of partitions, the indexer can identify the inverted indexes stored in the directory corresponding to the particular partition as relevant inverted indexes. Other means can be used to identify inverted indexes associated with a partition of interest. For example, in some embodiments, the indexer can review an entry in the inverted indexes, such as an index-value pair entry 513 to determine if a particular inverted index is relevant. If the filter criteria does not identify any partition, then the indexer can identify all inverted indexes managed by the indexer as relevant inverted indexes.
Similarly, if the filter criteria includes a time range, the indexer can identify inverted indexes corresponding to buckets that satisfy at least a portion of the time range as relevant inverted indexes. For example, if the time range is last hour then the indexer can identify all inverted indexes that correspond to buckets storing events associated with timestamps within the last hour as relevant inverted indexes.
When used in combination, an index filter criterion specifying one or more partitions and a time range filter criterion specifying a particular time range can be used to identify a subset of inverted indexes within a particular directory (or otherwise associated with a particular partition) as relevant inverted indexes. As such, the indexer can focus the processing to only a subset of the total number of inverted indexes that the indexer manages.
Once the relevant inverted indexes are identified, the indexer can review them using any additional filter criteria to identify events that satisfy the filter criteria. In some cases, using the known location of the directory in which the relevant inverted indexes are located, the indexer can determine that any events identified using the relevant inverted indexes satisfy an index filter criterion. For example, if the filter criteria includes a partition main, then the indexer can determine that any events identified using inverted indexes within the partition main directory (or otherwise associated with the partition main) satisfy the index filter criterion.
Furthermore, based on the time range associated with each inverted index, the indexer can determine that that any events identified using a particular inverted index satisfies a time range filter criterion. For example, if a time range filter criterion is for the last hour and a particular inverted index corresponds to events within a time range of 50 minutes ago to 35 minutes ago, the indexer can determine that any events identified using the particular inverted index satisfy the time range filter criterion. Conversely, if the particular inverted index corresponds to events within a time range of 59 minutes ago to 62 minutes ago, the indexer can determine that some events identified using the particular inverted index may not satisfy the time range filter criterion.
Using the inverted indexes, the indexer can identify event references (and therefore events) that satisfy the filter criteria. For example, if the token “error” is a filter criterion, the indexer can track all event references within the token entry “error.” Similarly, the indexer can identify other event references located in other token entries or field-value pair entries that match the filter criteria. The system can identify event references located in all of the entries identified by the filter criteria. For example, if the filter criteria include the token “error” and field-value pair sourcetype::web_ui, the indexer can track the event references found in both the token entry “error” and the field-value pair entry sourcetype::web_ui. As mentioned previously, in some cases, such as when multiple values are identified for a particular filter criterion (e.g., multiple sources for a source filter criterion), the system can identify event references located in at least one of the entries corresponding to the multiple values and in all other entries identified by the filter criteria. The indexer can determine that the events associated with the identified event references satisfy the filter criteria.
In some cases, the indexer can further consult a timestamp associated with the event reference to determine whether an event satisfies the filter criteria. For example, if an inverted index corresponds to a time range that is partially outside of a time range filter criterion, then the indexer can consult a timestamp associated with the event reference to determine whether the corresponding event satisfies the time range criterion. In some embodiments, to identify events that satisfy a time range, the indexer can review an array, such as the event reference array 515 that identifies the time associated with the events. Furthermore, as mentioned above using the known location of the directory in which the relevant inverted indexes are located (or other index identifier), the indexer can determine that any events identified using the relevant inverted indexes satisfy the index filter criterion.
In some cases, based on the filter criteria, the indexer reviews an extraction rule. In certain embodiments, if the filter criteria includes a field name that does not correspond to a field-value pair entry in an inverted index, the indexer can review an extraction rule, which may be located in a configuration file, to identify a field that corresponds to a field-value pair entry in the inverted index.
For example, the filter criteria includes a field name “sessionID” and the indexer determines that at least one relevant inverted index does not include a field-value pair entry corresponding to the field name sessionID, the indexer can review an extraction rule that identifies how the sessionID field is to be extracted from a particular host, source, or sourcetype (implicitly identifying the particular host, source, or sourcetype that includes a sessionID field). The indexer can replace the field name “sessionID” in the filter criteria with the identified host, source, or sourcetype. In some cases, the field name “sessionID” may be associated with multiples hosts, sources, or sourcetypes, in which case, all identified hosts, sources, and sourcetypes can be added as filter criteria. In some cases, the identified host, source, or sourcetype can replace or be appended to a filter criterion, or be excluded. For example, if the filter criteria includes a criterion for source S1 and the “sessionID” field is found in source S2, the source S2 can replace S1 in the filter criteria, be appended such that the filter criteria includes source S1 and source S2, or be excluded based on the presence of the filter criterion source S1. If the identified host, source, or sourcetype is included in the filter criteria, the indexer can then identify a field-value pair entry in the inverted index that includes a field value corresponding to the identity of the particular host, source, or sourcetype identified using the extraction rule.
Once the events that satisfy the filter criteria are identified, the system, such as the indexer 206 can categorize the results based on the categorization criteria. The categorization criteria can include categories for grouping the results, such as any combination of partition, source, sourcetype, or host, or other categories or fields as desired.
The indexer can use the categorization criteria to identify categorization criteria-value pairs or categorization criteria values by which to categorize or group the results. The categorization criteria-value pairs can correspond to one or more field-value pair entries stored in a relevant inverted index, one or more index-value pairs based on a directory in which the inverted index is located or an entry in the inverted index (or other means by which an inverted index can be associated with a partition), or other criteria-value pair that identifies a general category and a particular value for that category. The categorization criteria values can correspond to the value portion of the categorization criteria-value pair.
As mentioned, in some cases, the categorization criteria-value pairs can correspond to one or more field-value pair entries stored in the relevant inverted indexes. For example, the categorization criteria-value pairs can correspond to field-value pair entries of host, source, and sourcetype (or other field-value pair entry as desired). For instance, if there are ten different hosts, four different sources, and five different sourcetypes for an inverted index, then the inverted index can include ten host field-value pair entries, four source field-value pair entries, and five sourcetype field-value pair entries. The indexer can use the nineteen distinct field-value pair entries as categorization criteria-value pairs to group the results.
Specifically, the indexer can identify the location of the event references associated with the events that satisfy the filter criteria within the field-value pairs, and group the event references based on their location. As such, the indexer can identify the particular field value associated with the event corresponding to the event reference. For example, if the categorization criteria include host and sourcetype, the host field-value pair entries and sourcetype field-value pair entries can be used as categorization criteria-value pairs to identify the specific host and sourcetype associated with the events that satisfy the filter criteria.
In addition, as mentioned, categorization criteria-value pairs can correspond to data other than the field-value pair entries in the relevant inverted indexes. For example, if partition or index is used as a categorization criterion, the inverted indexes may not include partition field-value pair entries. Rather, the indexer can identify the categorization criteria-value pair associated with the partition based on the directory in which an inverted index is located, information in the inverted index, or other information that associates the inverted index with the partition, etc. As such a variety of methods can be used to identify the categorization criteria-value pairs from the categorization criteria.
Accordingly based on the categorization criteria (and categorization criteria-value pairs), the indexer can generate groupings based on the events that satisfy the filter criteria. As a non-limiting example, if the categorization criteria includes a partition and sourcetype, then the groupings can correspond to events that are associated with each unique combination of partition and sourcetype. For instance, if there are three different partitions and two different sourcetypes associated with the identified events, then the six different groups can be formed, each with a unique partition value-sourcetype value combination. Similarly, if the categorization criteria includes partition, sourcetype, and host and there are two different partitions, three sourcetypes, and five hosts associated with the identified events, then the indexer can generate up to thirty groups for the results that satisfy the filter criteria. Each group can be associated with a unique combination of categorization criteria-value pairs (e.g., unique combinations of partition value sourcetype value, and host value).
In addition, the indexer can count the number of events associated with each group based on the number of events that meet the unique combination of categorization criteria for a particular group (or match the categorization criteria-value pairs for the particular group). With continued reference to the example above, the indexer can count the number of events that meet the unique combination of partition, sourcetype, and host for a particular group.
Each indexer communicates the groupings to the search head. The search head can aggregate the groupings from the indexers and provide the groupings for display. In some cases, the groups are displayed based on at least one of the host, source, sourcetype, or partition associated with the groupings. In some embodiments, the search head can further display the groups based on display criteria, such as a display order or a sort order as described in greater detail above.
As a non-limiting example and with reference to FIG. 5B, consider a request received by an indexer 206 that includes the following filter criteria: keyword=error, partition=_main, time range=3/1/17 16:22.00.000-16:28.00.000, sourcetype=sourcetypeC, host=hostB, and the following categorization criteria:source.
Based on the above criteria, the indexer 206 identifies _main directory 503 and can ignore _test directory 505 and any other partition-specific directories. The indexer determines that inverted partition 507B is a relevant partition based on its location within the _main directory 503 and the time range associated with it. For sake of simplicity in this example, the indexer 206 determines that no other inverted indexes in the _main directory 503, such as inverted index 507A satisfy the time range criterion.
Having identified the relevant inverted index 507B, the indexer reviews the token entries 511 and the field-value pair entries 513 to identify event references, or events that satisfy all of the filter criteria.
With respect to the token entries 511, the indexer can review the error token entry and identify event references 3, 5, 6, 8, 11, 12, indicating that the term “error” is found in the corresponding events. Similarly, the indexer can identify event references 4, 5, 6, 8, 9, 10, 11 in the field-value pair entry sourcetype::sourcetypeC and event references 2, 5, 6, 8, 10, 11 in the field-value pair entry host::hostB. As the filter criteria did not include a source or an IP_address field-value pair, the indexer can ignore those field-value pair entries.
In addition to identifying event references found in at least one token entry or field-value pair entry (e.g., event references 3, 4, 5, 6, 8, 9, 10, 11, 12), the indexer can identify events (and corresponding event references) that satisfy the time range criterion using the event reference array 1614 (e.g., event references 2, 3, 4, 5, 6, 7, 8, 9, 10). Using the information obtained from the inverted index 507B (including the event reference array 515), the indexer 206 can identify the event references that satisfy all of the filter criteria (e.g., event references 5, 6, 8).
Having identified the events (and event references) that satisfy all of the filter criteria, the indexer 206 can group the event references using the received categorization criteria (source). In doing so, the indexer can determine that event references 5 and 6 are located in the field-value pair entry source::sourceD (or have matching categorization criteria-value pairs) and event reference 8 is located in the field-value pair entry source::sourceC. Accordingly, the indexer can generate a sourceC group having a count of one corresponding to reference 8 and a sourceD group having a count of two corresponding to references 5 and 6. This information can be communicated to the search head. In turn the search head can aggregate the results from the various indexers and display the groupings. As mentioned above, in some embodiments, the groupings can be displayed based at least in part on the categorization criteria, including at least one of host, source, sourcetype, or partition.
It will be understood that a change to any of the filter criteria or categorization criteria can result in different groupings. As a one non-limiting example, a request received by an indexer 206 that includes the following filter criteria: partition=_main, time range=3/1/17 3/1/17 16:21:20.000-16:28:17.000, and the following categorization criteria: host, source, sourcetype would result in the indexer identifying event references 1-12 as satisfying the filter criteria. The indexer would then generate up to 24 groupings corresponding to the 24 different combinations of the categorization criteria-value pairs, including host (hostA, hostB), source (sourceA, sourceB, sourceC, sourceD), and sourcetype (sourcetypeA, sourcetypeB, sourcetypeC). However, as there are only twelve events identifiers in the illustrated embodiment and some fall into the same grouping, the indexer generates eight groups and counts as follows:
Group 1 (hostA, sourceA, sourcetypeA): 1 (event reference 7)
Group 2 (hostA, sourceA, sourcetypeB): 2 (event references 1, 12)
Group 3 (hostA, sourceA, sourcetypeC): 1 (event reference 4)
Group 4 (hostA, sourceB, sourcetypeA): 1 (event reference 3)
Group 5 (hostA, sourceB, sourcetypeC): 1 (event reference 9)
Group 6 (hostB, sourceC, sourcetypeA): 1 (event reference 2)
Group 7 (hostB, sourceC, sourcetypeC): 2 (event references 8, 11)
Group 8 (hostB, sourceD, sourcetypeC): 3 (event references 5, 6, 10)
As noted, each group has a unique combination of categorization criteria-value pairs or categorization criteria values. The indexer communicates the groups to the search head for aggregation with results received from other indexers. In communicating the groups to the search head, the indexer can include the categorization criteria-value pairs for each group and the count. In some embodiments, the indexer can include more or less information. For example, the indexer can include the event references associated with each group and other identifying information, such as the indexer or inverted index used to identify the groups.
As another non-limiting examples, a request received by an indexer 206 that includes the following filter criteria: partition=_main, time range=3/1/17 3/1/17 16:21:20.000-16:28:17.000, source=sourceA, sourceD, and keyword=itemID and the following categorization criteria: host, source, sourcetype would result in the indexer identifying event references 4, 7, and 10 as satisfying the filter criteria, and generate the following groups:
Group 1 (hostA, sourceA, sourcetypeC): 1 (event reference 4)
Group 2 (hostA, sourceA, sourcetypeA): 1 (event reference 7)
Group 3 (hostB, sourceD, sourcetypeC): 1(event references 10)
The indexer communicates the groups to the search head for aggregation with results received from other indexers. As will be understand there are myriad ways for filtering and categorizing the events and event references. For example, the indexer can review multiple inverted indexes associated with a partition or review the inverted indexes of multiple partitions, and categorize the data using any one or any combination of partition, host, source, sourcetype, or other category, as desired.
Further, if a user interacts with a particular group, the indexer can provide additional information regarding the group. For example, the indexer can perform a targeted search or sampling of the events that satisfy the filter criteria and the categorization criteria for the selected group, also referred to as the filter criteria corresponding to the group or filter criteria associated with the group.
In some cases, to provide the additional information, the indexer relies on the inverted index. For example, the indexer can identify the event references associated with the events that satisfy the filter criteria and the categorization criteria for the selected group and then use the event reference array 515 to access some or all of the identified events. In some cases, the categorization criteria values or categorization criteria-value pairs associated with the group become part of the filter criteria for the review.
With reference to FIG. 5B for instance, suppose a group is displayed with a count of six corresponding to event references 4, 5, 6, 8, 10, 11 (i.e., event references 4, 5, 6, 8, 10, 11 satisfy the filter criteria and are associated with matching categorization criteria values or categorization criteria-value pairs) and a user interacts with the group (e.g., selecting the group, clicking on the group, etc.). In response, the search head communicates with the indexer to provide additional information regarding the group.
In some embodiments, the indexer identifies the event references associated with the group using the filter criteria and the categorization criteria for the group (e.g., categorization criteria values or categorization criteria-value pairs unique to the group). Together, the filter criteria and the categorization criteria for the group can be referred to as the filter criteria associated with the group. Using the filter criteria associated with the group, the indexer identifies event references 4, 5, 6, 8, 10, 11.
Based on a sampling criteria, discussed in greater detail above, the indexer can determine that it will analyze a sample of the events associated with the event references 4, 5, 6, 8, 10, 11. For example, the sample can include analyzing event data associated with the event references 5, 8, 10. In some embodiments, the indexer can use the event reference array 515 to access the event data associated with the event references 5, 8, 10. Once accessed, the indexer can compile the relevant information and provide it to the search head for aggregation with results from other indexers. By identifying events and sampling event data using the inverted indexes, the indexer can reduce the amount of actual data this is analyzed and the number of events that are accessed in order to generate the summary of the group and provide a response in less time.
2.8. Query Processing
FIG. 6A is a flow diagram of an example method that illustrates how a search head and indexers perform a search query, in accordance with example embodiments. At block 602, a search head receives a search query from a client. At block 604, the search head analyzes the search query to determine what portion(s) of the query can be delegated to indexers and what portions of the query can be executed locally by the search head. At block 606, the search head distributes the determined portions of the query to the appropriate indexers. In some embodiments, a search head cluster may take the place of an independent search head where each search head in the search head cluster coordinates with peer search heads in the search head cluster to schedule jobs, replicate search results, update configurations, fulfill search requests, etc. In some embodiments, the search head (or each search head) communicates with a master node (also known as a cluster master, not shown in FIG. 2) that provides the search head with a list of indexers to which the search head can distribute the determined portions of the query. The master node maintains a list of active indexers and can also designate which indexers may have responsibility for responding to queries over certain sets of events. A search head may communicate with the master node before the search head distributes queries to indexers to discover the addresses of active indexers.
At block 608, the indexers to which the query was distributed, search data stores associated with them for events that are responsive to the query. To determine which events are responsive to the query, the indexer searches for events that match the criteria specified in the query. These criteria can include matching keywords or specific values for certain fields. The searching operations at block 608 may use the late-binding schema to extract values for specified fields from events at the time the query is processed. In some embodiments, one or more rules for extracting field values may be specified as part of a source type definition in a configuration file. The indexers may then either send the relevant events back to the search head, or use the events to determine a partial result, and send the partial result back to the search head.
At block 610, the search head combines the partial results and/or events received from the indexers to produce a final result for the query. In some examples, the results of the query are indicative of performance or security of the IT environment and may help improve the performance of components in the IT environment. This final result may comprise different types of data depending on what the query requested. For example, the results can include a listing of matching events returned by the query, or some type of visualization of the data from the returned events. In another example, the final result can include one or more calculated values derived from the matching events.
The results generated by the system 108 can be returned to a client using different techniques. For example, one technique streams results or relevant events back to a client in real-time as they are identified. Another technique waits to report the results to the client until a complete set of results (which may include a set of relevant events or a result based on relevant events) is ready to return to the client. Yet another technique streams interim results or relevant events back to the client in real-time until a complete set of results is ready, and then returns the complete set of results to the client. In another technique, certain results are stored as “search jobs” and the client may retrieve the results by referring the search jobs.
The search head can also perform various operations to make the search more efficient. For example, before the search head begins execution of a query, the search head can determine a time range for the query and a set of common keywords that all matching events include. The search head may then use these parameters to query the indexers to obtain a superset of the eventual results. Then, during a filtering stage, the search head can perform field-extraction operations on the superset to produce a reduced set of search results. This speeds up queries, which may be particularly helpful for queries that are performed on a periodic basis.
2.9. Pipelined Search Language
Various embodiments of the present disclosure can be implemented using, or in conjunction with, a pipelined command language. A pipelined command language is a language in which a set of inputs or data is operated on by a first command in a sequence of commands, and then subsequent commands in the order they are arranged in the sequence. Such commands can include any type of functionality for operating on data, such as retrieving, searching, filtering, aggregating, processing, transmitting, and the like. As described herein, a query can thus be formulated in a pipelined command language and include any number of ordered or unordered commands for operating on data.
Splunk Processing Language (SPL) is an example of a pipelined command language in which a set of inputs or data is operated on by any number of commands in a particular sequence. A sequence of commands, or command sequence, can be formulated such that the order in which the commands are arranged defines the order in which the commands are applied to a set of data or the results of an earlier executed command. For example, a first command in a command sequence can operate to search or filter for specific data in particular set of data. The results of the first command can then be passed to another command listed later in the command sequence for further processing.
In various embodiments, a query can be formulated as a command sequence defined in a command line of a search UI. In some embodiments, a query can be formulated as a sequence of SPL commands Some or all of the SPL commands in the sequence of SPL commands can be separated from one another by a pipe symbol “|”. In such embodiments, a set of data, such as a set of events, can be operated on by a first SPL command in the sequence, and then a subsequent SPL command following a pipe symbol “|” after the first SPL command operates on the results produced by the first SPL command or other set of data, and so on for any additional SPL commands in the sequence. As such, a query formulated using SPL comprises a series of consecutive commands that are delimited by pipe “|” characters. The pipe character indicates to the system that the output or result of one command (to the left of the pipe) should be used as the input for one of the subsequent commands (to the right of the pipe). This enables formulation of queries defined by a pipeline of sequenced commands that refines or enhances the data at each step along the pipeline until the desired results are attained. Accordingly, various embodiments described herein can be implemented with Splunk Processing Language (SPL) used in conjunction with the SPLUNK® ENTERPRISE system.
While a query can be formulated in many ways, a query can start with a search command and one or more corresponding search terms at the beginning of the pipeline. Such search terms can include any combination of keywords, phrases, times, dates, Boolean expressions, fieldname-field value pairs, etc. that specify which results should be obtained from an index. The results can then be passed as inputs into subsequent commands in a sequence of commands by using, for example, a pipe character. The subsequent commands in a sequence can include directives for additional processing of the results once it has been obtained from one or more indexes. For example, commands may be used to filter unwanted information out of the results, extract more information, evaluate field values, calculate statistics, reorder the results, create an alert, create summary of the results, or perform some type of aggregation function. In some embodiments, the summary can include a graph, chart, metric, or other visualization of the data. An aggregation function can include analysis or calculations to return an aggregate value, such as an average value, a sum, a maximum value, a root mean square, statistical values, and the like.
Due to its flexible nature, use of a pipelined command language in various embodiments is advantageous because it can perform “filtering” as well as “processing” functions. In other words, a single query can include a search command and search term expressions, as well as data-analysis expressions. For example, a command at the beginning of a query can perform a “filtering” step by retrieving a set of data based on a condition (e.g., records associated with server response times of less than 1 microsecond). The results of the filtering step can then be passed to a subsequent command in the pipeline that performs a “processing” step (e.g. calculation of an aggregate value related to the filtered events such as the average response time of servers with response times of less than 1 microsecond). Furthermore, the search command can allow events to be filtered by keyword as well as field value criteria. For example, a search command can filter out all events containing the word “warning” or filter out all events where a field value associated with a field “clientip” is “10.0.1.2.”
The results obtained or generated in response to a command in a query can be considered a set of results data. The set of results data can be passed from one command to another in any data format. In one embodiment, the set of result data can be in the form of a dynamically created table. Each command in a particular query can redefine the shape of the table. In some implementations, an event retrieved from an index in response to a query can be considered a row with a column for each field value. Columns contain basic information about the data and also may contain data that has been dynamically extracted at search time.
FIG. 6B provides a visual representation of the manner in which a pipelined command language or query operates in accordance with the disclosed embodiments. The query 630 can be inputted by the user into a search. The query comprises a search, the results of which are piped to two commands (namely, command 1 and command 2) that follow the search step.
Disk 622 represents the event data in the raw record data store.
When a user query is processed, a search step will precede other queries in the pipeline in order to generate a set of events at block 640. For example, the query can comprise search terms “sourcetype=syslog ERROR” at the front of the pipeline as shown in FIG. 6B. Intermediate results table 624 shows fewer rows because it represents the subset of events retrieved from the index that matched the search terms “sourcetype=syslog ERROR” from search command 630. By way of further example, instead of a search step, the set of events at the head of the pipeline may be generating by a call to a pre-existing inverted index (as will be explained later).
At block 642, the set of events generated in the first part of the query may be piped to a query that searches the set of events for field-value pairs or for keywords. For example, the second intermediate results table 626 shows fewer columns, representing the result of the top command, “top user” which summarizes the events into a list of the top 10 users and displays the user, count, and percentage.
Finally, at block 644, the results of the prior stage can be pipelined to another stage where further filtering or processing of the data can be performed, e.g., preparing the data for display purposes, filtering the data based on a condition, performing a mathematical calculation with the data, etc. As shown in FIG. 6B, the “fields—percent” part of command 630 removes the column that shows the percentage, thereby, leaving a final results table 628 without a percentage column. In different embodiments, other query languages, such as the Structured Query Language (“SQL”), can be used to create a query.
2.10. Field Extraction
The search head 210 allows users to search and visualize events generated from machine data received from homogenous data sources. The search head 210 also allows users to search and visualize events generated from machine data received from heterogeneous data sources. The search head 210 includes various mechanisms, which may additionally reside in an indexer 206, for processing a query. A query language may be used to create a query, such as any suitable pipelined query language. For example, Splunk Processing Language (SPL) can be utilized to make a query. SPL is a pipelined search language in which a set of inputs is operated on by a first command in a command line, and then a subsequent command following the pipe symbol “|” operates on the results produced by the first command, and so on for additional commands Other query languages, such as the Structured Query Language (“SQL”), can be used to create a query.
In response to receiving the search query, search head 210 uses extraction rules to extract values for fields in the events being searched. The search head 210 obtains extraction rules that specify how to extract a value for fields from an event. Extraction rules can comprise regex rules that specify how to extract values for the fields corresponding to the extraction rules. In addition to specifying how to extract field values, the extraction rules may also include instructions for deriving a field value by performing a function on a character string or value retrieved by the extraction rule. For example, an extraction rule may truncate a character string or convert the character string into a different data format. In some cases, the query itself can specify one or more extraction rules.
The search head 210 can apply the extraction rules to events that it receives from indexers 206. Indexers 206 may apply the extraction rules to events in an associated data store 208. Extraction rules can be applied to all the events in a data store or to a subset of the events that have been filtered based on some criteria (e.g., event time stamp values, etc.). Extraction rules can be used to extract one or more values for a field from events by parsing the portions of machine data in the events and examining the data for one or more patterns of characters, numbers, delimiters, etc., that indicate where the field begins and, optionally, ends.
FIG. 7A is a diagram of an example scenario where a common customer identifier is found among log data received from three disparate data sources, in accordance with example embodiments. In this example, a user submits an order for merchandise using a vendor's shopping application program 701 running on the user's system. In this example, the order was not delivered to the vendor's server due to a resource exception at the destination server that is detected by the middleware code 702. The user then sends a message to the customer support server 703 to complain about the order failing to complete. The three systems 701, 702, and 703 are disparate systems that do not have a common logging format. The order application 701 sends log data 704 to the data intake and query system in one format, the middleware code 702 sends error log data 705 in a second format, and the support server 703 sends log data 706 in a third format.
Using the log data received at one or more indexers 206 from the three systems, the vendor can uniquely obtain an insight into user activity, user experience, and system behavior. The search head 210 allows the vendor's administrator to search the log data from the three systems that one or more indexers 206 are responsible for searching, thereby obtaining correlated information, such as the order number and corresponding customer ID number of the person placing the order. The system also allows the administrator to see a visualization of related events via a user interface. The administrator can query the search head 210 for customer ID field value matches across the log data from the three systems that are stored at the one or more indexers 206. The customer ID field value exists in the data gathered from the three systems, but the customer ID field value may be located in different areas of the data given differences in the architecture of the systems. There is a semantic relationship between the customer ID field values generated by the three systems. The search head 210 requests events from the one or more indexers 206 to gather relevant events from the three systems. The search head 210 then applies extraction rules to the events in order to extract field values that it can correlate. The search head may apply a different extraction rule to each set of events from each system when the event format differs among systems. In this example, the user interface can display to the administrator the events corresponding to the common customer ID field values 707, 708, and 709, thereby providing the administrator with insight into a customer's experience.
Note that query results can be returned to a client, a search head, or any other system component for further processing. In general, query results may include a set of one or more events, a set of one or more values obtained from the events, a subset of the values, statistics calculated based on the values, a report containing the values, a visualization (e.g., a graph or chart) generated from the values, and the like.
The search system enables users to run queries against the stored data to retrieve events that meet criteria specified in a query, such as containing certain keywords or having specific values in defined fields. FIG. 7B illustrates the manner in which keyword searches and field searches are processed in accordance with disclosed embodiments.
If a user inputs a search query into search bar 710 that includes only keywords (also known as “tokens”), e.g., the keyword “error” or “warning”, the query search engine of the data intake and query system searches for those keywords directly in the event data 711 stored in the raw record data store. Note that while FIG. 7B only illustrates four events 712, 713, 714, 715, the raw record data store (corresponding to data store 208 in FIG. 2) may contain records for millions of events.
As disclosed above, an indexer can optionally generate a keyword index to facilitate fast keyword searching for event data. The indexer includes the identified keywords in an index, which associates each stored keyword with reference pointers to events containing that keyword (or to locations within events where that keyword is located, other location identifiers, etc.). When an indexer subsequently receives a keyword-based query, the indexer can access the keyword index to quickly identify events containing the keyword. For example, if the keyword “HTTP” was indexed by the indexer at index time, and the user searches for the keyword “HTTP”, the events 712, 713, and 714, will be identified based on the results returned from the keyword index. As noted above, the index contains reference pointers to the events containing the keyword, which allows for efficient retrieval of the relevant events from the raw record data store.
If a user searches for a keyword that has not been indexed by the indexer, the data intake and query system would nevertheless be able to retrieve the events by searching the event data for the keyword in the raw record data store directly as shown in FIG. 7B. For example, if a user searches for the keyword “frank”, and the name “frank” has not been indexed at index time, the data intake and query system will search the event data directly and return the first event 712. Note that whether the keyword has been indexed at index time or not, in both cases the raw data of the events 712-715 is accessed from the raw data record store to service the keyword search. In the case where the keyword has been indexed, the index will contain a reference pointer that will allow for a more efficient retrieval of the event data from the data store. If the keyword has not been indexed, the search engine will need to search through all the records in the data store to service the search.
In most cases, however, in addition to keywords, a user's search will also include fields. The term “field” refers to a location in the event data containing one or more values for a specific data item. Often, a field is a value with a fixed, delimited position on a line, or a name and value pair, where there is a single value to each field name. A field can also be multivalued, that is, it can appear more than once in an event and have a different value for each appearance, e.g., email address fields. Fields are searchable by the field name or field name-value pairs. Some examples of fields are “clientip” for IP addresses accessing a web server, or the “From” and “To” fields in email addresses.
By way of further example, consider the search, “status=404”. This search query finds events with “status” fields that have a value of “404.” When the search is run, the search engine does not look for events with any other “status” value. It also does not look for events containing other fields that share “404” as a value. As a result, the search returns a set of results that are more focused than if “404” had been used in the search string as part of a keyword search. Note also that fields can appear in events as “key=value” pairs such as “user_name=Bob.” But in most cases, field values appear in fixed, delimited positions without identifying keys. For example, the data store may contain events where the “user_name” value always appears by itself after the timestamp as illustrated by the following string: “Nov 15 09:33:22 johnmedlock.”
The data intake and query system advantageously allows for search time field extraction. In other words, fields can be extracted from the event data at search time using late-binding schema as opposed to at data ingestion time, which was a major limitation of the prior art systems.
In response to receiving the search query, search head 210 uses extraction rules to extract values for the fields associated with a field or fields in the event data being searched. The search head 210 obtains extraction rules that specify how to extract a value for certain fields from an event. Extraction rules can comprise regex rules that specify how to extract values for the relevant fields. In addition to specifying how to extract field values, the extraction rules may also include instructions for deriving a field value by performing a function on a character string or value retrieved by the extraction rule. For example, a transformation rule may truncate a character string, or convert the character string into a different data format. In some cases, the query itself can specify one or more extraction rules.
FIG. 7B illustrates the manner in which configuration files may be used to configure custom fields at search time in accordance with the disclosed embodiments. In response to receiving a search query, the data intake and query system determines if the query references a “field.” For example, a query may request a list of events where the “clientip” field equals “127.0.0.1.” If the query itself does not specify an extraction rule and if the field is not a metadata field, e.g., time, host, source, source type, etc., then in order to determine an extraction rule, the search engine may, in one or more embodiments, need to locate configuration file 716 during the execution of the search as shown in FIG. 7B.
Configuration file 716 may contain extraction rules for all the various fields that are not metadata fields, e.g., the “clientip” field. The extraction rules may be inserted into the configuration file in a variety of ways. In some embodiments, the extraction rules can comprise regular expression rules that are manually entered in by the user. Regular expressions match patterns of characters in text and are used for extracting custom fields in text.
In one or more embodiments, as noted above, a field extractor may be configured to automatically generate extraction rules for certain field values in the events when the events are being created, indexed, or stored, or possibly at a later time. In one embodiment, a user may be able to dynamically create custom fields by highlighting portions of a sample event that should be extracted as fields using a graphical user interface. The system would then generate a regular expression that extracts those fields from similar events and store the regular expression as an extraction rule for the associated field in the configuration file 716.
In some embodiments, the indexers may automatically discover certain custom fields at index time and the regular expressions for those fields will be automatically generated at index time and stored as part of extraction rules in configuration file 716. For example, fields that appear in the event data as “key=value” pairs may be automatically extracted as part of an automatic field discovery process. Note that there may be several other ways of adding field definitions to configuration files in addition to the methods discussed herein.
The search head 210 can apply the extraction rules derived from configuration file 716 to event data that it receives from indexers 206. Indexers 206 may apply the extraction rules from the configuration file to events in an associated data store 208. Extraction rules can be applied to all the events in a data store, or to a subset of the events that have been filtered based on some criteria (e.g., event time stamp values, etc.). Extraction rules can be used to extract one or more values for a field from events by parsing the event data and examining the event data for one or more patterns of characters, numbers, delimiters, etc., that indicate where the field begins and, optionally, ends.
In one more embodiments, the extraction rule in configuration file 716 will also need to define the type or set of events that the rule applies to. Because the raw record data store will contain events from multiple heterogeneous sources, multiple events may contain the same fields in different locations because of discrepancies in the format of the data generated by the various sources. Furthermore, certain events may not contain a particular field at all. For example, event 715 also contains “clientip” field, however, the “clientip” field is in a different format from the events 712, 713, and 714. To address the discrepancies in the format and content of the different types of events, the configuration file will also need to specify the set of events that an extraction rule applies to, e.g., extraction rule 717 specifies a rule for filtering by the type of event and contains a regular expression for parsing out the field value. Accordingly, each extraction rule will pertain to only a particular type of event. If a particular field, e.g., “clientip” occurs in multiple events, each of those types of events would need its own corresponding extraction rule in the configuration file 716 and each of the extraction rules would comprise a different regular expression to parse out the associated field value. The most common way to categorize events is by source type because events generated by a particular source can have the same format.
The field extraction rules stored in configuration file 716 perform search-time field extractions. For example, for a query that requests a list of events with source type “access_combined” where the “clientip” field equals “127.0.0.1,” the query search engine would first locate the configuration file 716 to retrieve extraction rule 717 that would allow it to extract values associated with the “clientip” field from the event data 720 “where the source type is “access_combined. After the “clientip” field has been extracted from all the events comprising the “clientip” field where the source type is “access_combined,” the query search engine can then execute the field criteria by performing the compare operation to filter out the events where the “clientip” field equals “127.0.0.1.” In the example shown in FIG. 7B, the events 712, 713, and 714 would be returned in response to the user query. In this manner, the search engine can service queries containing field criteria in addition to queries containing keyword criteria (as explained above).
The configuration file can be created during indexing. It may either be manually created by the user or automatically generated with certain predetermined field extraction rules. As discussed above, the events may be distributed across several indexers, wherein each indexer may be responsible for storing and searching a subset of the events contained in a corresponding data store. In a distributed indexer system, each indexer would need to maintain a local copy of the configuration file that is synchronized periodically across the various indexers.
The ability to add schema to the configuration file at search time results in increased efficiency. A user can create new fields at search time and simply add field definitions to the configuration file. As a user learns more about the data in the events, the user can continue to refine the late-binding schema by adding new fields, deleting fields, or modifying the field extraction rules in the configuration file for use the next time the schema is used by the system. Because the data intake and query system maintains the underlying raw data and uses late-binding schema for searching the raw data, it enables a user to continue investigating and learn valuable insights about the raw data long after data ingestion time.
The ability to add multiple field definitions to the configuration file at search time also results in increased flexibility. For example, multiple field definitions can be added to the configuration file to capture the same field across events generated by different source types. This allows the data intake and query system to search and correlate data across heterogeneous sources flexibly and efficiently.
Further, by providing the field definitions for the queried fields at search time, the configuration file 716 allows the record data store to be field searchable. In other words, the raw record data store can be searched using keywords as well as fields, wherein the fields are searchable name/value pairings that distinguish one event from another and can be defined in configuration file 716 using extraction rules. In comparison to a search containing field names, a keyword search does not need the configuration file and can search the event data directly as shown in FIG. 7B.
It should also be noted that any events filtered out by performing a search-time field extraction using a configuration file can be further processed by directing the results of the filtering step to a processing step using a pipelined search language. Using the prior example, a user could pipeline the results of the compare step to an aggregate function by asking the query search engine to count the number of events where the “clientip” field equals “127.0.0.1.”
3.0. Trace and Span Sampling and Analysis for Instrumented Software
Software developers monitor different aspects of software they develop by instrumenting the software. These aspects include performance of the software, disk utilization of the software, CPU utilization of the software, errors encountered during execution of the software, significant events encountered during execution of the software, information describing which parts of code are being executed and which parts are not being executed, and so on. After development, similar aspects of the software are also monitored during production, for example, when software is being executed on a cloud architecture.
Computing operations can be described by spans and traces. As used herein, a “span” is an atomic computing operation performed in handling a request, and may include an operation name (e.g., “start”), a service (e.g., “analytics”), and start and end timestamps. Spans may be annotated with additional tags, such as key:value pairs, that provide further context regarding the execution environment. As used herein, a “trace” is a set of spans traversed in the handing of a single request.
According to embodiments, each span and trace may have a duration equal to the difference between the start and end timestamps for the span, or for the group of span forming the trace. Instrumented software may be instrumented to emit spans and traces. The spans and traces can be generated according to an industry standard, such as the OpenTracing standard. Each span may be annotated with one or more tags that provide context about the execution, such as the user instrumenting the software, a document involved in the request, an infrastructure element used in servicing a request, etc.
Communicating all of the spans and traces produced by a software application to an analysis system and storing these spans and traces imposes a serious infrastructure cost. Furthermore, it is unnecessary to transfer and store all emitted spans and traces, since code usually executes quickly and without errors. In prior implementations, traces emitted by a software application were randomly sampled and transmitted for analysis. However, certain types of traces provide more valuable information, and random sampling may not surface these traces. For example, if most traces are error-free, and only a few indicate errors, a random sampling scheme provides a large amount of uninteresting, error-free traces, and may miss the traces that indicate errors.
To obtain a sample of traces that includes a higher proportion of interesting traces, a gateway performs tail-based sampling of traces. The gateway resides at the instrumented software, receives all emitted spans and traces, and in real or near-real time, selects traces to transmit to an analysis system. For example, the gateway selects a portion of traces that include an interesting span (e.g., selecting for spans with long durations), a portion of traces that include a span with an error, and a portion of traces selected based on overall trace duration. The gateway may select spans and traces using a statistical model that references a reservoir of spans and traces. The gateway maintains in the reservoir a collection of duration values that describe the distributions of durations for recently received traces and recently received spans, and the span or trace distribution is used to calculate a score for each received span or trace. Each emitted trace has a chance of being selected, but the gateway favors selecting longer or unusual spans and traces. Each selected trace is associated with a weight indicating the likelihood that the trace is stored according to the statistical model.
The gateway may use a dynamic timeout mechanism to determine when a trace is complete. For example, the dynamic timeout mechanism may include both a fixed duration (e.g., 100 ms) and a variable duration that is calculated based on durations of other traces. If a trace reaches the larger of the fixed duration and the variable duration, it is considered complete and passed through the sampling mechanism in the gateway. The reservoir of recently received traces may be used to calculate the variable duration; for example, the variable duration may be, for example, five times the 99th percentile duration for a trace or a curve based on duration. Both the fixed duration and the variable duration may be configurable. The dynamic timeout mechanism provides a balance between completeness/accuracy and timeliness. In addition, the dynamic timeout mechanism saves memory compared to using only a longer fixed duration, since in most cases, the sampling decision can be made sooner than if only a long fixed duration (e.g., 5 minutes) is used.
The analysis system receives the traces selected by the gateway and performs analysis on the selected traces. The analysis system may derive a distribution of all of the emitted spans and traces (not just the selected traces) based on the weights. The analysis system may receive traces, with their component spans and associated tags, from multiple instances of instrumented software.
In an embodiment, the analysis system compares durations of a set of similar spans (e.g., spans for the same type of request) with the tags associated with these spans and determines whether there are any patterns for a given tag. The analysis system generates a histogram that represents a distribution of durations for a set of spans. For a given tag, the analysis system calculates a p-value indicating the likelihood that the ranks of the spans for that tag in the distribution arose by chance. In particular, the analysis system may calculate a p-value of the Mann-Whitney U-statistic comparing the ranks of the durations of the traces having the tag to the other traces in the distribution. A larger U-statistic indicates that the spans for that tag skew rightward, i.e., that they tend to have long durations relative to other spans in the distribution. The analysis system can provide alerts regarding the tags whose spans have relatively long duration. Long duration spans may be indicative of configuration problems at the instrumented systems. The analysis system may correct the p-value for the number of hypotheses tested, for example by multiplying the p-value by the total number of tags. This procedure defines a map from tags to non-negative real numbers. The analysis system sorts the tags by the associated p-value (e.g., in ascending order) and returns those with p-value less than or equal to some threshold, e.g., 0.01.
In another embodiment, the analysis system uncovers patterns relating span tags to error spans, which are spans that cause an error or exception to be thrown. This can highlight possible explanations for errors and help users understand patterns among errors. For example, the analysis system can determine if error spans tend to come from a particular user (whose requests might be somehow malformed). To analyze errors, the analysis system computes, for each tag, the chi-squared statistic for the null hypothesis that the presence of the tag is statistically independent of whether the span is an error. The statistic will be larger (and the associated p-value smaller) when the tag is significantly more common among error spans than it is among non-error spans. The analysis system may correct the p-value for the number of hypotheses tested, for example by multiplying the p-value by the total number of tags. This procedure defines a map from tags to non-negative real numbers. The analysis system sorts the tags by the associated p-value (in ascending order) and returns those with p-value less than or equal to some threshold, e.g., 0.01.
The disclosed system addresses a problem in traditional data analysis of instrumented software tied to computer technology, namely, the technical problem of infrastructure data storage cost. The disclosed system solves this technical problem by providing a solution also rooted in computer technology, namely, by providing for tail-based sampling and analysis of instrumented software that includes a higher proportion of traces of interest. The disclosed subject technology further provides improvements to the functioning of the computer itself because it reduces the cost of data storage on the infrastructure.
3.1. System for Reporting Based on Instrumented Software
FIG. 7 shows the overall system environment for reporting based on instrumented software, according to an embodiment. The overall system environment includes an instrumentation analysis system 700, one or more client devices 720, an administration system 760, and a reporting system 750. In other embodiments, more or less components than those indicated in FIG. 7 may be used. For example, client devices 720, administration system 760, and reporting system 750 may interact with instrumentation analysis system 700 via a network (not shown in FIG. 7). Furthermore, there may be more or less instances of each system shown in FIG. 7, for example, there may be multiple reporting systems 750.
FIG. 7 and the other figures use like reference numerals to identify like elements. A letter after a reference numeral, such as “730a,” indicates that the text refers specifically to the element having that particular reference numeral. A reference numeral in the text without a following letter, such as “730,” refers to any or all of the elements in the figures bearing that reference numeral (e.g., “730” in the text refers to reference numerals “730a” and/or “730b” in the figures).
The instrumentation analysis system 700 receives data comprising values of metrics sent by different client devices 720 (e.g., the instrumentation analysis system 700 may also be referred to herein as an analysis system or a data analysis system). A client device 720 executes instrumented software, for example, application 730. Although, application 730 is shown in FIG. 7 as an example of instrumented software, the techniques disclosed herein are not limited to application software but are applicable to other kinds of software, for example, server software, software executing on customer devices, websites, and so on. Furthermore, a client device 720 may include any computing system that is configured to execute instrumented software, whether or not it is used for development of improved software. For example, the client device 720 may be a computing system used for testing purposes, staging purposes, or any production system executing in an enterprise.
The software executing on a client device 720 is configured to send information generated as a result of instrumenting the software to instrumentation analysis system 700. For example, the application 730 may send values corresponding to various metrics as they are generated to instrumentation analysis system 700. The application 730 may send group values of metrics and send them periodically to instrumentation analysis system 700. Different applications 730 may send the same metric or different metrics at different rates. The same application may send different metrics at different rates. In an implementation, the application 730 may send data to the instrumentation analysis system 700 by invoking an application programming interface (API) supported by the instrumentation analysis system 700.
A gauge comprises instructions to measure certain runtime characteristics of the application 730, for example, heap size, number of cache misses or hits, active memory used, CPU (central processing unit) utilization, total time taken to respond to a request, time taken to connect to a service, and so on. A gauge may also be used to track certain application specific parameters or business related values, for example, number of transactions, number of users, and so on. The gauge may be invoked periodically based on an interval that is configurable. The value of the gauge is sent to instrumentation analysis system 700 periodically.
A software program may be instrumented to generate spans with a common field in their data structures to designate spans that are part of a common trace. For example, the spans may include a trace identifier such that spans with the same trace identifier are a part of the same trace. A length of each trace may be determined by an administrator through the administration system 760.
The administration system 760 allows a privileged user, for example, a system administrator to associate data streams with metadata. The administration system 760 comprises the administration application 770 that provides a user interface for a system administrator to specify the metadata. The metadata comprises properties, for example, name-value pairs. The instrumentation analysis system 700 receives metadata describing data streams and stores the metadata. The ability to specify metadata describing data streams independently from the data received from each data stream provides several benefits in generating reports based on the data stream.
As an example, the instrumentation analysis system 700 can receive modifications to metadata describing each data stream without requiring any modifications to the instrumented software of the application 730. As a result, the instrumentation analysis system 700 receives specifications of new reports and modifications to existing reports and generates results based on the new/modified reports without requiring the developers to modify applications 730.
Furthermore, the instrumentation analysis system 700 can also receive and process reports built on top of existing reports by composing existing reports and adding new analytics functionality. The instrumentation analysis system 700 generates results of the new reports and sends them for presentation in real-time as the instrumentation analysis system 700 receives data streams from instrumented software. The instrumentation analysis system 700 generates these additional reports and modifies existing reports without requiring any modifications to the instrumented code of application 730.
Furthermore, the instrumentation analysis system 700 provides separation of the metadata describing the data streams from the data of the data streams. Accordingly, the amount of data that needs to be transmitted from the client devices 720 to the instrumentation analysis system 700 is reduced. Each application 730 transmits only the data values of the metrics and information identifying the metric. The metadata information is received separately from a source independent of the data source of the data streams. Accordingly, any amount of metadata may be introduced without increasing the amount of data of each data stream.
The reporting system 750 may be configured to generate a histogram to analyze generated spans and traces. In an implementation, the reporting system 750 may include a histogram generator 740 that interacts with the instrumentation analysis system 700 to generate a histogram.
The reporting system 750 can be a conventional computer system (e.g., a desktop or laptop computer), a tablet, or a device having computer functionality such as a personal digital assistant (PDA), a mobile telephone, a smart phone or another suitable device. The reporting system 750 interacts with instrumentation analysis system 700 via a network. The network may comprise any combination of local area and/or wide area networks, using both wired and/or wireless communication systems. In one embodiment, the network uses standard communications technologies and/or protocols.
The instrumentation analysis system 700 may be hosted on a computing system that includes one or more processors, memory, secondary storage and input/output controller. The computing system used for hosting the instrumentation analysis system 700 is typically a server class system that uses powerful processors, large memory, and fast input/output systems compared to a typical computing system used, for example, as a reporting system 750.
In an embodiment, data from several client devices 720 may be consolidated, for example, by a server and the combined data sent to the instrumentation analysis system 700. For example, an enterprise may install a server that receives data stream internally from different client devices 720 and sends the combined data in a batch form to the instrumentation analysis system 700 periodically. This allows efficiency of external communication from the enterprise.
A data stream may be identified by using a set of coordinates representing values of dimensions associated with data streams. A dimension refers to a property of data streams that can take one of a set of values. Each data stream may be associated with a value for a dimension. For example, a dimension can be a source of a data stream or a metric name associated with a data stream. A source of a data stream may be identified by a server name, a service name, and so on. Examples of metric names are cpu (central processing unit) load, cache misses, cache hits, and so on. A value of a dimension is also referred to as a coordinate value of the data stream. A coordinate value may be represented as a metadata attribute stored in a metadata store. Given the two dimensions of source and metric, a data stream may be identified by providing the two coordinates representing the source and the metric, for example, (server1, cpu_load) or (server2, memory_usage).
A data stream may be characterized by multiple dimensions (i.e., more than the two dimensions described above, i.e., source and metric name) For example, if each server has multiple cpus, a dimension cpu_id may be included. Accordingly, each data stream obtained from a system may be characterized by (source_id, cpu_id, metric_name), i.e., a source identifier, a cpu identifier, and a name for the metric. Examples of data streams identified using three coordinates include (server1, cpu1, load), (server1, cpu2, load), (server2, cpu1, load), (server2, cpu2, load) and so on. According to embodiments, each data stream may include spans and traces.
As another example of a dimension, a system may define customer name as a dimension. The name of the customer may be reported by the instrumented software, for example, based on the configuration parameters of the instrumented software executing on a client device 720. The customer name may be specified for the instrumented software using a system property. The instrumented software includes the customer name when it identifies a data stream associated with that particular customer. The ability to associate a data stream with a customer allows the instrumentation analysis system to perform customer specific analysis, for example, report on usages of systems for each customer, identify customers reporting more than a threshold number of errors and so on.
A data stream may be obtained from instrumented software or may be generated as a result of execution of blocks of a data stream language program within the instrumentation analysis system. A data stream may also comprise data stored in the instrumentation analysis system, for example, in a data store, such as a time series data store 860 described herein.
FIG. 8 shows an architecture of a system for processing data streams received from instrumented software, according to an embodiment. The instrumentation analysis system 700 includes an interface module 810, a quantization module 840, metadata module 820, metadata store 830, a data point routing module 850, an analytics engine 870, a user interface manager 880, a time series data store 860, and software bus 890. In other embodiments, the instrumentation analysis system 700 may include other modules not described herein. Functionality indicated as provided by a particular module may be implemented by other modules instead.
The interface module 810 receives requests from external systems, for example, client devices 720 that communicate with the instrumentation analysis system 700. The interface module 810 supports various application programming interfaces (APIs) that external systems can invoke. The interface module 810 can receive and process data provided by applications 730 that are instrumented using functionality provided by different vendors, so long as the instrumented code sends the information in a format that can be processed by the interface module 810.
The interface module 810 receives data in the form of data streams comprising spans and traces from one or more client devices 720. In an embodiment, the interface module 810 receives data and represents the incoming data as tuples. Accordingly, each data stream is represented as a plurality of tuples, each tuple representing a data point. A tuple of data received by the interface module 810 comprises various elements. A tuple of data includes a metric identifier, for example, a name of the metric corresponding to the tuple and a value of the metric. The tuple of data received may further comprise other elements, for example, a timestamp corresponding to the time that the data was captured by the application 730 sending the data, one or more properties associated with the data.
In an embodiment, the timestamp associated with a tuple represents the time that the data value was received by the instrumentation analysis system 700. The properties associated with the data may be provided in the form of name, value pairs. These properties may provide additional information describing the data received, for example, information describing the source of the data such as a host name, server name, device name, or service name associated with the source, a method or function name associated with the data, an application instance identifier, and so on.
In an embodiment, the interface module 810 generates and assigns an identifier to records received by the interface module 810. The identifier is referred to herein as a time series identifier (also referred to herein as a TSID or tsid). A unique time series identifier is assigned to all tuples matching a metric name and a set of properties received with the tuple. Accordingly, a tuple (metric name, properties, metric value, timestamp) gets mapped to a tuple (tsid, metric value, timestamp). For example, if a tuple provides a metric name m1, and a hostname h1, all tuples with metric name m1 and hostname h1 are assigned the same time series identifier. Accordingly, the tsid uniquely identifies all tuples of a data stream received by the instrumentation analysis system 700.
The metadata module 820 receives and stores metadata information describing various data streams received from the client devices 720. In an embodiment, the metadata stored in the metadata module 820 is received from a user, for example, a system administrator interacting with the instrumentation analysis system 700 using the administration system 760.
The metadata may be represented as name-value pairs. In an embodiment, the metadata is represented as metadata objects, each object defining a set of properties that may be represented as name-value pairs. A set of data streams may be associated with the metadata object. Accordingly, all properties represented by the metadata object are associated with each data stream that is associated with the metadata object.
The metadata store 830 stores the metadata objects and their associations with the data streams. The metadata store 830 stores an identifier (ID) for each metadata object and the properties represented by the metadata object. In an embodiment, each data stream is associated with a time series identifier that uniquely identifies the data stream. The metadata store 830 stores an index that maps each metadata object to a set of time series identifier values. The metadata store 830 may receive instructions to modify a metadata object. For example, the metadata store 830 may receive instructions to modify, add or delete some properties represented by a metadata object. Alternatively, the metadata store 830 may receive instructions to modify the mapping from a metadata object to a data stream. For example, the metadata store 830 may receive instructions to associate a data stream with a metadata object or delete an association between a metadata object and a data stream.
In an embodiment, the metadata store 830 is represented as a relational database but may be represented as any other type of database or data store. For example, the metadata store 830 may be a relational database storing tables that map metadata object IDs to time series IDs identifying data streams. Other database tables may store the properties associated with each metadata object as a mapping from metadata object ID to each property represented as a name-value pair.
The time series data store 860 stores data received from various sources, for example, client devices 720. The time series data store 860 is also referred to herein as time series database (or TSDB.) In an embodiment, the time series data store 860 also stores the time series data after the data is quantized. The time series data store 860 may also store rollup data for each time series. The time series data store 860 also stores results of various analytics requests, for example, results of various reports requested by user. The analytics engine 870 computes results for certain reports, for example, moving averages over intervals of time by combining data stored in the time series data store 860 with new data obtained as data stream from various sources.
The software bus 890 provides a mechanism for modules of the instrumentation analysis system 700 to provide data of data streams to other modules of the instrumentation analysis system 700. A data stream language program may send a data stream to the software bus 890. Other modules, for example, fetch modules, window modules, and so on can read the data from the software bus 890 and perform further processing on the data. For example, a data stream output of a data stream language program published on the software bus 890 may be identified by a find block of another data stream language program executing as a job.
3.2. Sampling Traces and Spans of Instrumented Software
Embodiments of the present disclosure provide for tail-based sampling of traces that satisfies three somewhat conflicting requirements: 1) sampling should prefer “interesting traces”, 2) trace duration histograms should be reflective of the overall population, not only a persisted subpopulation, and 3) there should be minimal coordination between a sampler (e.g., a process that makes sampling decisions) and an analyzer (e.g., a process that calculates distributions). As used herein, “interesting traces” include traces that are instances of relatively infrequently occurring paths, have abnormally long durations, contain a span of abnormally long duration, or contain an error span.
FIG. 9 shows an example of a system 900 for sampling and analyzing spans and traces of instrumented software, according to an embodiment of the present disclosure. The system 900 may include a gateway 910 having a sampler 920. The gateway 910 may also be communicatively coupled to an analyzer 930.
To obtain a sample of traces that includes a higher proportion of interesting traces, the gateway 910 may be configured to perform tail-based sampling of traces through the sampler 920. In an implementation, the gateway 910 may reside at the instrumented software to receive all emitted spans and traces, and in real or near-real time, select traces to transmit to the analyzer 930. For example, the gateway 910 may be configured to select a portion of traces that include an interesting span (e.g., selecting for spans with long durations), a portion of traces that include a span with an error, and a portion of traces selected based on overall trace duration.
According to embodiments, the gateway 910 be configured to select spans and traces using a statistical model that references a reservoir of spans and traces. The gateway 910 may maintain in the reservoir a collection of duration values that describe distributions of durations for recently received traces and recently received spans. The span or trace distribution may then be utilized to calculate a score for each received span or trace. Each emitted trace has a chance of being selected, but the gateway 910 favors selecting longer or unusual spans and traces. Each selected trace may be associated with a weight indicating a likelihood that the trace is stored according to the statistical model.
According to embodiments, the gateway 910 may use a dynamic timeout mechanism to determine when a trace is complete. For example, the dynamic timeout mechanism may include both a fixed duration (e.g., 100 ms) and a variable duration that is calculated based on durations of other traces. For example, if a trace reaches the larger of the fixed duration and the variable duration, it is considered complete and passed through the sampling mechanism in the gateway. In an implementation, the reservoir of recently received traces may be used to calculate a variable duration. For example, the variable duration may be, five times the 99th percentile duration for a trace, or a curve based on duration. Both the fixed duration and the variable duration may be configurable. The dynamic timeout mechanism provides a balance between completeness/accuracy and timeliness. In addition, the dynamic timeout mechanism saves memory compared to using only a longer fixed duration, since in most cases, the sampling decision can be made sooner than if only a long fixed duration (e.g., 5 minutes) is used.
According to embodiments, the statistical model may be included in the sampler 920. For example, the sampler 920 may configured to perform tail-based sampling of spans and traces according to an algorithm. The algorithm may include the following steps:
(1) Partition the set of spans by operation, service, and whether the span is an error, and maintain for each element s of the partition: an exponentially decaying reservoir of durations Rs, and an (exponentially weighted) estimate cs of the count of the span over some interval T. For example, s may be a tuple of (operation, service, error), where the error component is Boolean.
(2) Partition the set of traces by initiating span, initiating service, and (if present) HTTP method, and maintain for each element t of the partition: an exponentially decaying reservoir of durations Rt, and an (exponentially weighted) estimate ct of the count of the trace over some interval T.
(3) The algorithm takes as input a budget B of traces to keep per time interval T; and a decomposition B=Btrace+Bspan+BerrorSpan, expressing how the budget will be divided. For example, B may be determined dynamically.
(4) During the first time interval T, keep spans and traces until the budget is exhausted. Use all spans and traces to estimate the counts and reservoirs.
(5) When, as is typical, Σs′∈(*, *, False)cs′>Bspan (or similarly for other index sets), divide up Bspan among the various (non-erroneous) s using the heuristic that if span α is ten times more common than span β, span α should appear in the sampled set only twice as often as does span β. Let w:R>0→R denote the function mapping x to 2 log x, (e.g., log may be base 10). The span s is allocated w(cs)/Σs′w(cs′) of the budget Bspan. Therefore the aim is to keep BspanW(Cs)/Σs′W(Cs′) of these every time interval, and the baseline probability ps is




  
    (
    
      
        
          
            B
            span
          
          ⁢
          
            w
            ⁡
            
              (
              
                c
                s
              
              )
            
          
        
        
          
            c
            s
          
          ⁢
          
            
              ∑
              
                s
                ′
              
            
            ⁢
            
              w
              ⁡
              
                (
                
                  c
                  
                    s
                    ′
                  
                
                )
              
            
          
        
      
      ,
      1
    
    )
  
  .




When




  
    
      
        
          B
          span
        
        ⁢
        
          w
          ⁡
          
            (
            
              c
              s
            
            )
          
        
      
      
        (
        
          
            c
            s
          
          ⁢
          
            
              ∑
              
                s
                ′
              
            
            ⁢
            
              w
              ⁡
              
                (
                
                  c
                  
                    s
                    ′
                  
                
                )
              
            
          
        
        )
      
    
    >
    1
  
  ,




re-allocate the unused budget among the other spans. Repeat the above for error spans and traces. This step (refreshing how the budget is allocated) is repeated once every time interval T.

(6) Span-level procedure. Use Rs to calculate the (exponentially weighted) percentile (expressed as a number between 0 and 1) of the duration of an instance of a span s, and denote this percentile by x; let as denote the (unique) real number satisfying as(1−1n as)=ps and keep the instance of this span with probability min(as/(1−x), 1). Once the decision is made to keep a span, keep the containing trace. Incorporate the instance into Rs,cs. The number as is selected so that




  
    
      
        
          
            
              
                ∫
                0
              
              1
            
            ⁢
            
              min
              ⁡
              
                (
                
                  
                    a
                    s
                  
                  
                    1
                    -
                    x
                  
                
                )
              
            
          
          ,
          1
        
        )
      
      ⁢
      dx
    
    =
    
      p
      s
    
  
  ,




(i.e., keep proportion ps overall). The sampling curve 1/(1−x) is selected to retain the same number of samples from the regions [0, 1/2], [1/2, 3/4], [3/4, 7/8], etc.

(7) Trace-level procedure and scoring. Use the procedure described in (6) (with Rt, pt) to decide whether to keep a trace. If it is decided to keep the trace, annotate it with a count field with value the reciprocal of the probability, i.e., 1/min(as/(1−x), 1). Do this even if it was already decided to keep the trace because of the span-level procedure. Thus, traces kept for span-level reasons may or may not have the count field. According to embodiments, the field being absent will be interpreted as zero for the purposes of histogram estimation. During initialization/priming (the first time interval T), do not record a count. Incorporate the instance of the trace into Rt, ct.
According to embodiments, a mechanism may be implemented to protect against retaining too many traces when an overall volume of traffic increases. As described above, the relation:




  
    
      B
      span
    
    ⁢
    
      w
      ⁡
      
        (
        
          c
          s
        
        )
      
    
  
  
    
      ∑
      
        s
        ′
      
    
    ⁢
    
      w
      ⁡
      
        (
        
          c
          
            s
            ′
          
        
        )
      
    
  




may specify a target retention volume per unit time for the identity indexed by s. The baseline probability ps may dynamically adjusted during the time interval according to how much of this quantity has been consumed. If traffic increases during the beginning of the interval, the baseline ps will be lowered with the goal of retaining the target during the interval. For example, keeping ps would retain too many traces in this scenario. If traffic dips, the baseline will be correspondingly increased. There is essentially no adjustment when the traffic is steady and is distributed uniformly throughout the interval.

The analyzer 930 may then receive the tail-based samples of spans and traces to construct a histogram. According to embodiments, when constructing a histogram of trace durations, the analyzer 930 may use the count field to estimate the probability density function. In this way, any bias that may have been introduced by the sampler 920 may be negated. As a result, the persisted subpopulation will be biased towards the upper tail (e.g., as many samples in P50, P75 as in P0, P50), so the density function will lie above the persisted subpopulation towards the lower tail and below it towards the upper tail.
3.3. Analyzing Traces and Spans of Instrumented Software
According to embodiments, the analyzer 930 receives the traces selected by the gateway 910 and performs analysis on the selected traces. The analyzer 930 may derive a distribution of all of the emitted spans and traces (i.e., not just the selected traces) based on the calculated weights. In an implementation, the analyzer 930 may receive traces, with their component spans and associated tags, from multiple instances of instrumented software.
According to embodiments, the analyzer 930 may be configured to compare durations of a set of similar spans (e.g., spans for the same type of request) with the tags associated with these spans. The analyzer 930 may then determine whether there are any patterns for a given tag. The analysis system generates a histogram that represents a distribution of durations for a set of spans. For a given tag, the analyzer 930 may calculate a p-value indicating a likelihood that the ranks of the spans for that tag in the distribution arose by chance.
In an implementation, the analyzer 930 may calculate a Mann-Whitney U-statistic p-value that compares the ranks of the durations of the traces having the tag to the other traces in the distribution. For example, a larger U-statistic indicates that the spans for that tag skew rightward (i.e., that they tend to have long durations relative to other spans in the distribution).
The analyzer 930 may also be configured to provide alerts regarding the tags whose spans have a relatively long duration. This is because long duration spans may be indicative of configuration problems at the instrumented systems. The analyzer 930 may correct the p-value for the number of hypotheses tested. For example, the analyzer 930 may be configured to multiply the p-value by the total number of tags. In this way, a mapping of tags to non-negative real numbers may be defined. The analyzer 930 may then sort the tags by the associated p-value (e.g., in ascending order) and returns those with p-value less than or equal to a pre-defined threshold (e.g., 0.01).
According to embodiments, the analyzer 930 may be configured to uncover patterns relating span tags to error spans, which are spans that cause an error or an exception to be thrown. This can highlight possible explanations for errors and help users understand patterns among errors. For example, the analyzer 930 may determine if error spans tend to come from a particular user (e.g., whose requests might be somehow malformed). To analyze such errors, the analyzer 930 may compute, for each tag, the chi-squared statistic for the null hypothesis that the presence of the tag is statistically independent of whether the span is an error. The statistic will be larger (and the associated p-value smaller) when the tag is significantly more common among error spans than it is among non-error spans. The analyzer 930 may correct the p-value for the number of hypotheses tested, for example by multiplying the p-value by the total number of tags. This procedure defines a map from tags to non-negative real numbers. The analyzer 930 sorts the tags by the associated p-value (in ascending order) and returns those with p-value less than or equal to a pre-defined threshold (e.g., 0.01).
FIG. 10 illustrates a generated histogram 1000 for analysis of spans and traces, according to an embodiment of the present disclosure. The histogram 1000 may be generated by querying stored traces through a user interface. As shown, the histogram 1000 illustrates latencies of the traces in a given time period. For example, the histogram 1000 may be right-skewed.
As discussed above, each trace is comprised of multiple spans, and each span may include tags (e.g., key:value pairs) that provide information regarding characteristics of the span (e.g., such as what hosts the span ran on, or the user that made the request). For each trace, all of the tags on all of the spans that make up that trace may be accumulated. A comparison may then be made between traces containing a specific tag with traces not containing the specific tag. For example, distributions of traces containing the specific tag may be compared with distributions not containing the specific tag to determine a difference between the distributions. A statistic may be calculated based on the determined difference for each comparison. The calculated statistics may then be compared with each other to determine which tags 1010 are most over-represented on the right hand side of the distribution. For example, it may be determined that the presence of these tags 1010 (e.g., for traces that took longer than a second) correlate to a particular host or were requests made by particular user. With this information, steps may be taken to remedy the appropriate characteristic.
According to embodiments, the histogram 1000 uncovers patterns relating trace tags to trace durations (i.e., the histogram/distribution of trace durations), and thereby highlights possible explanations for degraded system performance (or slowness in steady state). For example, the histogram 1000 may be utilized to explain whether slow (i.e., longer duration) traces come from a particular customer, whose requests might be large or somehow malformed. The histogram may also be utilized to explain whether the slow traces tend to pass through the same (i.e., possibly overloaded or misconfigured) infrastructure.
In an implementation, an algorithm for analyzing the tail-based samples of spans and traces may be as follows:
(1) Given a collection of traces, associate with each trace the tags of all its constituent spans. This may be represented as a multimap of {key: {values }} because different spans in the same trace may have different values for the same key. For example, in a microservices environment, a trace will typically traverse many hosts.
(2) For every tag k:v, define T(k:v) to be those traces containing the tag on some span (i.e., the value v is in the set associated with the key k).
(3) For each tag, compute the p-value of the Mann-Whitney U-statistic comparing the ranks of the durations of the traces in T(k:v) (traces containing the tag) to the ranks of the durations of its complement (traces not containing the tag). A larger U-statistic corresponds to a smaller p-value, which corresponds to more rightward skew. This means traces with the tag are overrepresented among the slower traces. The statistic can be viewed as a measure of stochastic dominance Correct the p-value for the number of hypotheses tested, for example by multiplying the p-value by the total number of tags.
(4) Altogether the procedure of the preceding paragraph defines a map from tags to non-negative real numbers. Sort the tags by the associated p-value (in ascending order) and return those with p-value less than or equal to a pre-defined threshold (e.g., 0.01).
According to embodiments, this algorithm may be integrated into a user interface that supports querying for and visualizing of trace data. The result is a list of tags, sorted by how overrepresented they are among the slower traces. The results can easily be used as filters to further refine the trace query. In particular, the procedure can be applied iteratively (e.g., using the first result until a certain dataset size is reached).
The techniques described herein may be implemented as method(s) that are performed by physical computing device(s); as one or more non-transitory computer-readable storage media storing instructions which, when executed by computing device(s), cause performance of the method(s); or, as physical computing device(s) that are specially configured with a combination of hardware and software that causes performance of the method(s).
FIG. 11 is a flow diagram illustrative of an embodiment of a process 1100 for sampling and analyzing spans and traces of instrumented software, according to embodiments of the present disclosure. For explanatory purposes, the steps of the example process 1100 are described herein as occurring in serial, or linearly. However, multiple instances of the example process 1100 may occur in parallel.
At step 1102, selected traces are received from a gateway. The selected traces may include spans associated with tags. The selected traces may be selected through tail-based sampling of traces having a selected span, a span with an error, or an overall trace duration. At step 1104, durations of a set of similar spans of the selected traces are compared to determine patterns for the tags. At step 1106, a histogram is generated that represents a distribution of the durations of the set of similar spans. At step 1108, alerts are provided for tags associated with spans having a duration above a threshold based on the distribution of the durations.
In an implementation, a gateway (e.g., gateway 910 of FIG. 9) may select traces based on a tail-based sampling algorithm. For example, a sampler (e.g., sampler 920 of FIG. 9) may be integrated with the gateway to execute the tail-based sampling algorithm. An analyzer (e.g., analyzer 930 of FIG. 9) may be configured to compare durations of similar spans to determine patterns for tags of the spans. The analyzer may further be configured to generate a histogram (e.g., histogram 1000 of FIG. 10) that represents a distribution of durations for the similar spans. The analyzer may further be configured to generate alerts based on tags associated with the spans to improve performance of the instrumented software.
According to embodiments, the tail-based sampling is based on a statistical model that references decaying reservoirs of spans and traces. According to embodiments, each selected trace is associated with a weight. According to embodiments, the selected traces include at least one of an infrequently occurring path, an abnormally long duration, a span of abnormally long duration, or an error span.
According to embodiments, the process 1100 further includes partitioning a set of spans based on at least one of an operation, a service, or an error, and partitioning a set of traces by at least one of an initiating span, an initiating service, or an HTTP method. According to embodiments, the process 1100 further includes calculating a score for each received span or trace.
According to embodiments, the process 1100 further includes defining a duration of each trace based on a dynamic timeout mechanism, the dynamic timeout mechanism including a fixed duration and a variable duration, the variable duration calculated based on durations of other traces. According to embodiments, the process 1100 further includes defining the duration of each trace based on a longer of the fixed duration and the variable duration
According to embodiments, the process 1100 further includes calculating a Mann-Whitney U-statistic p-value to compare ranks of durations of traces having a specific tag to other traces in the distribution. According to embodiments, the process 1100 further includes sorting the tags by an associated p-value, and identifying tags with p-values less than or equal to a pre-defined threshold.
4.0. Terminology
Computer programs typically comprise one or more instructions set at various times in various memory devices of a computing device, which, when read and executed by at least one processor, will cause a computing device to execute functions involving the disclosed techniques. In some embodiments, a carrier containing the aforementioned computer program product is provided. The carrier is one of an electronic signal, an optical signal, a radio signal, or a non-transitory computer-readable storage medium.
Any or all of the features and functions described above can be combined with each other, except to the extent it may be otherwise stated above or to the extent that any such embodiments may be incompatible by virtue of their function or structure, as will be apparent to persons of ordinary skill in the art. Unless contrary to physical possibility, it is envisioned that (i) the methods/steps described herein may be performed in any sequence and/or in any combination, and (ii) the components of respective embodiments may be combined in any manner.
Although the subject matter has been described in language specific to structural features and/or acts, it is to be understood that the subject matter defined in the appended claims is not necessarily limited to the specific features or acts described above. Rather, the specific features and acts described above are disclosed as examples of implementing the claims, and other equivalent features and acts are intended to be within the scope of the claims.
Conditional language, such as, among others, “can,” “could,” “might,” or “may,” unless specifically stated otherwise, or otherwise understood within the context as used, is generally intended to convey that certain embodiments include, while other embodiments do not include, certain features, elements and/or steps. Thus, such conditional language is not generally intended to imply that features, elements and/or steps are in any way required for one or more embodiments or that one or more embodiments necessarily include logic for deciding, with or without user input or prompting, whether these features, elements and/or steps are included or are to be performed in any particular embodiment.
Unless the context clearly requires otherwise, throughout the description and the claims, the words “comprise,” “comprising,” and the like are to be construed in an inclusive sense, as opposed to an exclusive or exhaustive sense, e.g., in the sense of “including, but not limited to.” As used herein, the terms “connected,” “coupled,” or any variant thereof means any connection or coupling, either direct or indirect, between two or more elements; the coupling or connection between the elements can be physical, logical, or a combination thereof. Additionally, the words “herein,” “above,” “below,” and words of similar import, when used in this application, refer to this application as a whole and not to any particular portions of this application. Where the context permits, words using the singular or plural number may also include the plural or singular number respectively. The word “or” in reference to a list of two or more items, covers all of the following interpretations of the word: any one of the items in the list, all of the items in the list, and any combination of the items in the list. Likewise the term “and/or” in reference to a list of two or more items, covers all of the following interpretations of the word: any one of the items in the list, all of the items in the list, and any combination of the items in the list.
Conjunctive language such as the phrase “at least one of X, Y and Z,” unless specifically stated otherwise, is otherwise understood with the context as used in general to convey that an item, term, etc. may be either X, Y or Z, or any combination thereof. Thus, such conjunctive language is not generally intended to imply that certain embodiments require at least one of X, at least one of Y and at least one of Z to each be present. Further, use of the phrase “at least one of X, Y or Z” as used in general is to convey that an item, term, etc. may be either X, Y or Z, or any combination thereof.
In some embodiments, certain operations, acts, events, or functions of any of the algorithms described herein can be performed in a different sequence, can be added, merged, or left out altogether (e.g., not all are necessary for the practice of the algorithms). In certain embodiments, operations, acts, functions, or events can be performed concurrently, e.g., through multi-threaded processing, interrupt processing, or multiple processors or processor cores or on other parallel architectures, rather than sequentially.
Systems and modules described herein may comprise software, firmware, hardware, or any combination(s) of software, firmware, or hardware suitable for the purposes described. Software and other modules may reside and execute on servers, workstations, personal computers, computerized tablets, PDAs, and other computing devices suitable for the purposes described herein. Software and other modules may be accessible via local computer memory, via a network, via a browser, or via other means suitable for the purposes described herein. Data structures described herein may comprise computer files, variables, programming arrays, programming structures, or any electronic information storage schemes or methods, or any combinations thereof, suitable for the purposes described herein. User interface elements described herein may comprise elements from graphical user interfaces, interactive voice response, command line interfaces, and other suitable interfaces.
Further, processing of the various components of the illustrated systems can be distributed across multiple machines, networks, and other computing resources. In certain embodiments, one or more of the components of the data intake and query system 108 can be implemented in a remote distributed computing system. In this context, a remote distributed computing system or cloud-based service can refer to a service hosted by one more computing resources that are accessible to end users over a network, for example, by using a web browser or other application on a client device to interface with the remote computing resources. For example, a service provider may provide a data intake and query system 108 by managing computing resources configured to implement various aspects of the system (e.g., search head 210, indexers 206, etc.) and by providing access to the system to end users via a network.
When implemented as a cloud-based service, various components of the system 108 can be implemented using containerization or operating-system-level virtualization, or other virtualization technique. For example, one or more components of the system 108 (e.g., search head 210, indexers 206, etc.) can be implemented as separate software containers or container instances. Each container instance can have certain resources (e.g., memory, processor, etc.) of the underlying host computing system assigned to it, but may share the same operating system and may use the operating system's system call interface. Each container may provide an isolated execution environment on the host system, such as by providing a memory space of the host system that is logically isolated from memory space of other containers. Further, each container may run the same or different computer applications concurrently or separately, and may interact with each other. Although reference is made herein to containerization and container instances, it will be understood that other virtualization techniques can be used. For example, the components can be implemented using virtual machines using full virtualization or paravirtualization, etc. Thus, where reference is made to “containerized” components, it should be understood that such components may additionally or alternatively be implemented in other isolated execution environments, such as a virtual machine environment.
Likewise, the data repositories shown can represent physical and/or logical data storage, including, e.g., storage area networks or other distributed storage systems. Moreover, in some embodiments the connections between the components shown represent possible paths of data flow, rather than actual connections between hardware. While some examples of possible connections are shown, any of the subset of the components shown can communicate with any other subset of components in various implementations.
Embodiments are also described above with reference to flow chart illustrations and/or block diagrams of methods, apparatus (systems) and computer program products. Each block of the flow chart illustrations and/or block diagrams, and combinations of blocks in the flow chart illustrations and/or block diagrams, may be implemented by computer program instructions. Such instructions may be provided to a processor of a general purpose computer, special purpose computer, specially-equipped computer (e.g., comprising a high-performance database server, a graphics subsystem, etc.) or other programmable data processing apparatus to produce a machine, such that the instructions, which execute via the processor(s) of the computer or other programmable data processing apparatus, create means for implementing the acts specified in the flow chart and/or block diagram block or blocks. These computer program instructions may also be stored in a non-transitory computer-readable memory that can direct a computer or other programmable data processing apparatus to operate in a particular manner, such that the instructions stored in the computer-readable memory produce an article of manufacture including instruction means which implement the acts specified in the flow chart and/or block diagram block or blocks. The computer program instructions may also be loaded to a computing device or other programmable data processing apparatus to cause operations to be performed on the computing device or other programmable apparatus to produce a computer implemented process such that the instructions which execute on the computing device or other programmable apparatus provide steps for implementing the acts specified in the flow chart and/or block diagram block or blocks.
Any patents and applications and other references noted above, including any that may be listed in accompanying filing papers, are incorporated herein by reference. Aspects of the invention can be modified, if necessary, to employ the systems, functions, and concepts of the various references described above to provide yet further implementations of the invention. These and other changes can be made to the invention in light of the above Detailed Description. While the above description describes certain examples of the invention, and describes the best mode contemplated, no matter how detailed the above appears in text, the invention can be practiced in many ways. Details of the system may vary considerably in its specific implementation, while still being encompassed by the invention disclosed herein. As noted above, particular terminology used when describing certain features or aspects of the invention should not be taken to imply that the terminology is being redefined herein to be restricted to any specific characteristics, features, or aspects of the invention with which that terminology is associated. In general, the terms used in the following claims should not be construed to limit the invention to the specific examples disclosed in the specification, unless the above Detailed Description section explicitly defines such terms. Accordingly, the actual scope of the invention encompasses not only the disclosed examples, but also all equivalent ways of practicing or implementing the invention under the claims.
To reduce the number of claims, certain aspects of the invention are presented below in certain claim forms, but the applicant contemplates other aspects of the invention in any number of claim forms. Any claims intended to be treated under 35 U.S.C. § 112(f) will begin with the words “means for,” but use of the term “for” in any other context is not intended to invoke treatment under 35 U.S.C. § 112(f). Accordingly, the applicant reserves the right to pursue additional claims after filing this application, in either this application or in a continuing application.

## Claims

1. A computer-implemented method for sampling and analyzing spans and traces of instrumented software, comprising:
receiving, from a gateway, selected traces comprising spans associated with tags, the selected traces comprising one or more ingested spans, the ingested spans sharing a same trace identifier, the ingested spans being annotated with a plurality of tags, each tag being associated with a tag attribute and corresponding value, wherein at least one tag associated with an ingested span comprises dependency information between spans in an associated trace, the selected traces selected through tail-based sampling of traces having at least one of a selected span, a span with an error, or an overall trace duration, wherein each span and trace comprises a duration equal to a difference between a start time and an end time for the span or for a group of spans forming the trace,
wherein the tail-based sampling includes:
partitioning a set of spans based on at least one of an operation, a service, or an error, partitioning a set of traces by at least one of an initiating span, an initiating service, or an HTTP method, and
keeping select spans from the set of spans and select traces from the set of traces in decaying reservoirs of spans and traces based on an allocated budget for a predetermined time interval, the allocated budget indicating a value of traces and a value of spans to maintain in the reservoirs for the predetermined time interval;

comparing durations of a set of similar spans of the selected traces with the tags associated with the set of similar spans to determine patterns for the tags;
generating a histogram that represents a distribution of the durations of the set of similar spans for the tags based on the comparison and querying of stored traces; and
providing, in a graphical user interface, alerts for tags associated with spans having a duration above a threshold based on the distribution of the durations.

2. The computer-implemented method of claim 1, wherein the tail-based sampling is based on a statistical model that references the decaying reservoirs of spans and traces.

3. The computer-implemented method of claim 1, wherein each selected trace is associated with a weight.

4. The computer-implemented method of claim 1, wherein the selected traces comprise at least one of an infrequently occurring path, an abnormally long duration, a span of abnormally long duration, or an error span.

5. The computer-implemented method of claim 1, further comprising calculating a score for each received span or trace.

6. The computer-implemented method of claim 1, further comprising defining a duration of each trace based on a dynamic timeout mechanism, the dynamic timeout mechanism comprising a fixed duration and a variable duration, the variable duration calculated based on durations of other traces.

7. The computer-implemented method of claim 6, further comprising defining the duration of each trace based on a longer of the fixed duration and the variable duration.

8. The computer-implemented method of claim 1, further comprising calculating a Mann-Whitney U-statistic p-value to compare ranks of durations of traces having a specific tag to other traces in the distribution.

9. The computer-implemented method of claim 1, further comprising: sorting the tags by an associated p-value; and identifying tags with p-values less than or equal to a pre-defined threshold.

10. A system for sampling and analyzing spans and traces of instrumented software, the system comprising:
at least one memory having instructions stored thereon; and
at least one processor configured to execute the instructions, wherein the at least one processor is configured to:
receive, from a gateway, selected traces comprising spans associated with tags, the selected traces comprising one or more ingested spans, the ingested spans sharing a same trace identifier, the ingested spans being annotated with a plurality of tags, each tag being associated with a tag attribute and corresponding value, wherein at least one tag associated with an ingested span comprises dependency information between spans in an associated trace, the selected traces selected through tail-based sampling of traces having at least one of a selected span, a span with an error, or an overall trace duration, wherein each span and trace comprises a duration equal to a difference between a start time and an end time for the span or for a group of spans forming the trace, and
wherein the tail-based sampling causes the at least one processor to:
partition a set of spans based on at least one of an operation, a service, or an error,
partition a set of traces by at least one of an initiating span, an initiating service, or an HTTP method, and
keep select spans from the set of spans and select traces from the set of traces in decaying reservoirs of spans and traces based on an allocated budget for a predetermined time interval, the allocated budget indicating a value of traces and a value of spans to maintain in the reservoirs for the predetermined time interval;

compare durations of a set of similar spans of the selected traces with the tags associated with the set of similar spans to determine patterns for the tags;
generate a histogram that represents a distribution of the durations of the set of similar spans for the tags based on the comparison and querying of stored traces; and
provide, in a graphical user interface, alerts for tags associated with spans having a duration above a threshold based on the distribution of the durations.

11. The system of claim 10, wherein the tail-based sampling is based on a statistical model that references the decaying reservoirs of spans and traces.

12. The system of claim 10, wherein each selected trace is associated with a weight.

13. The system of claim 10, wherein the selected traces comprise at least one of an infrequently occurring path, an abnormally long duration, a span of abnormally long duration, or an error span.

14. The system of claim 10, further configured to calculate a score for each received span or trace.

15. The system of claim 10, further configured to define a duration of each trace based on a dynamic timeout mechanism, the dynamic timeout mechanism comprising a fixed duration and a variable duration, the variable duration calculated based on durations of other traces.

16. The system of claim 15, further configured to define the duration of each trace based on a longer of the fixed duration and the variable duration.

17. The system of claim 10, further configured to calculate a Mann-Whitney U-statistic p-value to compare ranks of durations of traces having a specific tag to other traces in the distribution.

18. The system of claim 10, further configured to: sort the tags by an associated p-value; and identify tags with p-values less than or equal to a pre-defined threshold.

19. A non-transitory computer-readable storage medium comprising instructions stored thereon, which when executed by one or more processors, cause the one or more processors to perform operations for sampling and analyzing spans and traces of instrumented software, comprising:
receiving, from a gateway, selected traces comprising spans associated with tags, the selected traces comprising one or more ingested spans, the ingested spans sharing a same trace identifier, the ingested spans being annotated with a plurality of tags, each tag being associated with a tag attribute and corresponding value, wherein at least one tag associated with an ingested span comprises dependency information between spans in an associated trace, the selected traces selected through tail-based sampling of traces having at least one of a selected span, a span with an error, or an overall trace duration, wherein each span and trace comprises a duration equal to a difference between a start time and an end time for the span or for a group of spans forming the trace,
wherein the tail-based sampling includes:
partitioning a set of spans based on at least one of an operation, a service, or an error,
partitioning a set of traces by at least one of an initiating span, an initiating service, or an HTTP method, and
keeping select spans from the set of spans and select traces from the set of traces in decaying reservoirs of spans and traces based on an allocated budget for a predetermined time interval, the allocated budget indicating a value of traces and a value of spans to maintain in the reservoirs for the predetermined time interval;

comparing durations of a set of similar spans of the selected traces with the tags associated with the set of similar spans to determine patterns for the tags;
generating a histogram that represents a distribution of the durations of the set of similar spans for the tags based on the comparison and querying of stored traces; and
providing, in a graphical user interface, alerts for tags associated with spans having a duration above a threshold based on the distribution of the durations.

20. The non-transitory computer-readable storage medium of claim 19, wherein the tail-based sampling is based on a statistical model that references the decaying reservoirs of spans and traces.

21. The non-transitory computer-readable storage medium of claim 19, wherein each selected trace is associated with a weight.

22. The non-transitory computer-readable storage medium of claim 19, wherein the selected traces comprise at least one of an infrequently occurring path, an abnormally long duration, a span of abnormally long duration, or an error span.

23. The non-transitory computer-readable storage medium of claim 19, further configured for calculating a score for each received span or trace.

24. The non-transitory computer-readable storage medium of claim 19, further configured for defining a duration of each trace based on a dynamic timeout mechanism, the dynamic timeout mechanism comprising a fixed duration and a variable duration, the variable duration calculated based on durations of other traces.

25. The non-transitory computer-readable storage medium of claim 24, further configured for defining the duration of each trace based on a longer of the fixed duration and the variable duration.

26. The non-transitory computer-readable storage medium of claim 19, further configured for calculating a Mann-Whitney U-statistic p-value to compare ranks of durations of traces having a specific tag to other traces in the distribution.

27. The non-transitory computer-readable storage medium of claim 19, further configured for: sorting the tags by an associated p-value; and identifying tags with p-values less than or equal to a pre-defined threshold.