Azure Spring Cloud logs integration
What is an Elastic integration?
This integration is powered by Elastic Agent. Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to our documentation for a detailed comparison between Beats and Elastic Agent.
Prefer to use Beats for this use case? See Filebeat modules for logs or Metricbeat modules for metrics.
See the integrations quick start guides to get started:
Azure Spring Cloud Logs integration provides insight into the operations of Azure Spring Cloud applications.
Azure Spring Apps is the new name for the Azure Spring Cloud service. You can use this integration while we prepare the transition to the new service name.
Users opting for Elastic Cloud native Azure integration can stream the Azure Spring Cloud logs directly to their partner solution clusters; you can find more information and steps here.
Refer to the Azure Logs page for more information about setting up and using this integration.
eventhub
:
string
It is a fully managed, real-time data ingestion service. Elastic recommends using only letters, numbers, and the hyphen (-) character for Event Hub names to maximize compatibility. You can use existing Event Hubs having underscores (_) in the Event Hub name; in this case, the integration will replace underscores with hyphens (-) when it uses the Event Hub name to create dependent Azure resources behind the scenes (e.g., the storage account container to store Event Hub consumer offsets). Elastic also recommends using a separate event hub for each log type as the field mappings of each log type differ.
Default value insights-operational-logs
.
consumer_group
:
string
The publish/subscribe mechanism of Event Hubs is enabled through consumer groups. A consumer group is a view (state, position, or offset) of an entire event hub. Consumer groups enable multiple consuming applications to each have a separate view of the event stream, and to read the stream independently at their own pace and with their own offsets.
Default value: $Default
connection_string
:
string
The connection string required to communicate with Event Hubs, steps here https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string.
A Blob Storage account is required in order to store/retrieve/update the offset or state of the eventhub messages. This means that after stopping the filebeat azure module it can start back up at the spot that it stopped processing messages.
storage_account
:
string
The name of the storage account the state/offsets will be stored and updated.
storage_account_key
:
string
The storage account key, this key will be used to authorize access to data in your storage account.
storage_account_container
:
string
The storage account container where the integration stores the checkpoint data for the consumer group. It is an advanced option to use with extreme care. You MUST use a dedicated storage account container for each Azure log type (activity, sign-in, audit logs, and others). DO NOT REUSE the same container name for more than one Azure log type. See Container Names for details on naming rules from Microsoft. The integration generates a default container name if not specified.
resource_manager_endpoint
:
string
Optional, by default we are using the azure public environment, to override, users can provide a specific resource manager endpoint in order to use a different azure environment.
Resource manager endpoints:
# Azure ChinaCloud
https://management.chinacloudapi.cn/
# Azure GermanCloud
https://management.microsoftazure.de/
# Azure PublicCloud
https://management.azure.com/
# Azure USGovernmentCloud
https://management.usgovcloudapi.net/
This is the springcloudlogs
data stream of the Azure Logs package. It will collect any Spring Cloud logs that have been streamed through an azure event hub.
An example event for springcloudlogs
looks as following:
{
"agent": {
"hostname": "docker-fleet-agent",
"name": "docker-fleet-agent",
"id": "ef999bb2-fe83-4ffa-aa0c-0b54b7598df4",
"type": "filebeat",
"ephemeral_id": "49d0a57c-119c-4a01-878c-d9b06fc81f65",
"version": "7.14.0"
},
"log": {
"level": "Informational"
},
"elastic_agent": {
"id": "ef999bb2-fe83-4ffa-aa0c-0b54b7598df4",
"version": "7.14.0",
"snapshot": true
},
"message": "2021-08-03 15:07:03.354 INFO [helloapp,,,] 1 --- [trap-executor-0] c.n.d.s.r.aws.ConfigClusterResolver : Resolving eureka endpoints via configuration",
"tags": [
"azure-springcloudlogs"
],
"geo": {
"name": "westeurope"
},
"cloud": {
"provider": "azure"
},
"@timestamp": "2021-08-03T15:07:03.354Z",
"ecs": {
"version": "1.10.0"
},
"data_stream": {
"namespace": "default",
"type": "logs",
"dataset": "azure.springcloudlogs"
},
"event": {
"agent_id_status": "verified",
"ingested": "2021-08-03T15:15:14.386889100Z",
"kind": "event",
"action": "Microsoft.AppPlatform/Spring/logs",
"dataset": "azure.springcloudlogs"
},
"azure": {
"subscription_id": "0E073EC1-C22F-4488-ADDE-DA35ED609CCD",
"springcloudlogs": {
"log_format": "RAW",
"operation_name": "Microsoft.AppPlatform/Spring/logs",
"category": "ApplicationConsole",
"event_category": "Administrative",
"logtag": "F",
"properties": {
"app_name": "helloapp",
"instance_name": "helloapp-default-8-56df6b7f56-4vr94",
"stream": "stdout",
"service_name": "obssprincloud",
"service_id": "99070c7524f14eaf970bbdf35f357772"
}
},
"resource": {
"provider": "MICROSOFT.APPPLATFORM/SPRING",
"name": "OBSSPRINCLOUD",
"id": "/SUBSCRIPTIONS/0E073EC1-C22F-4488-ADDE-DA35ED609CCD/RESOURCEGROUPS/TESTM/PROVIDERS/MICROSOFT.APPPLATFORM/SPRING/OBSSPRINCLOUD",
"group": "TESTM"
}
}
}
Exported fields
Field | Description | Type |
---|---|---|
@timestamp | Event timestamp. | date |
azure.correlation_id | Correlation ID | keyword |
azure.resource.authorization_rule | Authorization rule | keyword |
azure.resource.group | Resource group | keyword |
azure.resource.id | Resource ID | keyword |
azure.resource.name | Name | keyword |
azure.resource.namespace | Resource type/namespace | keyword |
azure.resource.provider | Resource type/namespace | keyword |
azure.springcloudlogs.category | Category | keyword |
azure.springcloudlogs.event_category | Event Category | keyword |
azure.springcloudlogs.log_format | ccpNamespace | keyword |
azure.springcloudlogs.logtag | Cloud | keyword |
azure.springcloudlogs.operation_name | Operation name | keyword |
azure.springcloudlogs.properties.app_name | Application name | keyword |
azure.springcloudlogs.properties.instance_name | Instance name | keyword |
azure.springcloudlogs.properties.logger | Logger | keyword |
azure.springcloudlogs.properties.service_id | Service ID | keyword |
azure.springcloudlogs.properties.service_name | Service name | keyword |
azure.springcloudlogs.properties.stack | Stack name | keyword |
azure.springcloudlogs.properties.stream | Stream | keyword |
azure.springcloudlogs.properties.thread | Thread | keyword |
azure.springcloudlogs.properties.type | Type | keyword |
azure.springcloudlogs.status | Status | keyword |
azure.subscription_id | Azure subscription ID | keyword |
azure.tenant_id | tenant ID | keyword |
client.ip | IP address of the client (IPv4 or IPv6). | ip |
cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword |
cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword |
cloud.image.id | Image ID for the cloud instance. | keyword |
cloud.instance.id | Instance ID of the host machine. | keyword |
cloud.instance.name | Instance name of the host machine. | keyword |
cloud.machine.type | Machine type of the host machine. | keyword |
cloud.project.id | The cloud project identifier. Examples: Google Cloud Project id, Azure Project id. | keyword |
cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword |
cloud.region | Region in which this host, resource, or service is located. | keyword |
container.id | Unique container id. | keyword |
container.image.name | Name of the image the container was built on. | keyword |
container.labels | Image labels. | object |
container.name | Container name. | keyword |
data_stream.dataset | Data stream dataset name. | constant_keyword |
data_stream.namespace | Data stream namespace. | constant_keyword |
data_stream.type | Data stream type. | constant_keyword |
destination.address | Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the .address field. Then it should be duplicated to .ip or .domain , depending on which one it is. | keyword |
destination.as.number | Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. | long |
destination.as.organization.name | Organization name. | keyword |
destination.as.organization.name.text | Multi-field of destination.as.organization.name . | match_only_text |
destination.geo.city_name | City name. | keyword |
destination.geo.continent_name | Name of the continent. | keyword |
destination.geo.country_iso_code | Country ISO code. | keyword |
destination.geo.country_name | Country name. | keyword |
destination.geo.location | Longitude and latitude. | geo_point |
destination.geo.name | User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. | keyword |
destination.geo.region_iso_code | Region ISO code. | keyword |
destination.geo.region_name | Region name. | keyword |
destination.ip | IP address of the destination (IPv4 or IPv6). | ip |
destination.port | Port of the destination. | long |
ecs.version | ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword |
event.action | The action captured by the event. This describes the information in the event. It is more specific than event.category . Examples are group-add , process-started , file-created . The value is normally defined by the implementer. | keyword |
event.category | This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. event.category represents the "big buckets" of ECS categories. For example, filtering on event.category:process yields all events relating to process activity. This field is closely related to event.type , which is used as a subcategory. This field is an array. This will allow proper categorization of some events that fall in multiple categories. | keyword |
event.created | event.created contains the date/time when the event was first read by an agent, or by your pipeline. This field is distinct from @timestamp in that @timestamp typically contain the time extracted from the original event. In most situations, these two timestamps will be slightly different. The difference can be used to calculate the delay between your source generating an event, and the time when your agent first processed it. This can be used to monitor your agent's or pipeline's ability to keep up with your event source. In case the two timestamps are identical, @timestamp should be used. | date |
event.dataset | Event dataset | constant_keyword |
event.duration | Duration of the event in nanoseconds. If event.start and event.end are known this value should be the difference between the end and start time. | long |
event.id | Unique ID to describe the event. | keyword |
event.ingested | Timestamp when an event arrived in the central data store. This is different from @timestamp , which is when the event originally occurred. It's also different from event.created , which is meant to capture the first time an agent saw the event. In normal conditions, assuming no tampering, the timestamps should chronologically look like this: @timestamp < event.created < event.ingested . | date |
event.kind | This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. event.kind gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not. | keyword |
event.module | Event module | constant_keyword |
event.type | This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. event.type represents a categorization "sub-bucket" that, when used along with the event.category field values, enables filtering events down to a level appropriate for single visualization. This field is an array. This will allow proper categorization of some events that fall in multiple event types. | keyword |
file.mime_type | MIME type should identify the format of the file or stream of bytes using https://www.iana.org/assignments/media-types/media-types.xhtml[IANA official types], where possible. When more than one type is applicable, the most specific type should be used. | keyword |
file.size | File size in bytes. Only relevant when file.type is "file". | long |
geo.city_name | City name. | keyword |
geo.continent_name | Name of the continent. | keyword |
geo.country_iso_code | Country ISO code. | keyword |
geo.country_name | Country name. | keyword |
geo.location | Longitude and latitude. | geo_point |
geo.name | User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. | keyword |
host.architecture | Operating system architecture. | keyword |
host.containerized | If the host is a container. | boolean |
host.domain | Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider. | keyword |
host.hostname | Hostname of the host. It normally contains what the hostname command returns on the host machine. | keyword |
host.id | Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of beat.name . | keyword |
host.ip | Host ip addresses. | ip |
host.mac | Host MAC addresses. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. | keyword |
host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. | keyword |
host.os.build | OS build information. | keyword |
host.os.codename | OS codename, if any. | keyword |
host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword |
host.os.kernel | Operating system kernel version as a raw string. | keyword |
host.os.name | Operating system name, without the version. | keyword |
host.os.name.text | Multi-field of host.os.name . | match_only_text |
host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword |
host.os.version | Operating system version as a raw string. | keyword |
host.type | Type of host. For Cloud providers this can be the machine type like t2.medium . If vm, this could be the container, for example, or other information meaningful in your environment. | keyword |
log.level | Original log level of the log event. If the source of the event provides a log level or textual severity, this is the one that goes in log.level . If your source doesn't specify one, you may put your event transport's severity here (e.g. Syslog severity). Some examples are warn , err , i , informational . | keyword |
message | For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. If multiple messages exist, they can be combined into one message. | match_only_text |
network.community_id | A hash of source and destination IPs and ports, as well as the protocol used in a communication. This is a tool-agnostic standard to identify flows. Learn more at https://github.com/corelight/community-id-spec. | keyword |
related.ip | All of the IPs seen on your event. | ip |
related.user | All the user names or other user identifiers seen on the event. | keyword |
source.address | Some event source addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the .address field. Then it should be duplicated to .ip or .domain , depending on which one it is. | keyword |
source.as.number | Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. | long |
source.as.organization.name | Organization name. | keyword |
source.as.organization.name.text | Multi-field of source.as.organization.name . | match_only_text |
source.geo.city_name | City name. | keyword |
source.geo.continent_name | Name of the continent. | keyword |
source.geo.country_iso_code | Country ISO code. | keyword |
source.geo.country_name | Country name. | keyword |
source.geo.location | Longitude and latitude. | geo_point |
source.geo.name | User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. | keyword |
source.geo.region_iso_code | Region ISO code. | keyword |
source.geo.region_name | Region name. | keyword |
source.ip | IP address of the source (IPv4 or IPv6). | ip |
tags | List of keywords used to tag each event. | keyword |
user.domain | Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. | keyword |
user.full_name | User's full name, if available. | keyword |
user.full_name.text | Multi-field of user.full_name . | match_only_text |
user.id | Unique identifier of the user. | keyword |
user.name | Short name or login of the user. | keyword |
user.name.text | Multi-field of user.name . | match_only_text |
Version | Details |
---|---|
1.5.13 | Enhancement View pull request Extend the Storage Account container documentation and add link to requiements and setup instructions |
1.5.12 | Enhancement View pull request Added categories and/or subcategories. |
1.5.11 | Enhancement View pull request Add a new message format to the AzureFirewallNetworkRule log category |
1.5.10 | Bug fix View pull request Check for 'event.original' already existing in Application Gateway and Event Hub ingest pipelines |
1.5.9 | Bug fix View pull request Check for 'event.original' already existing in firewall logs ingest pipeline |
1.5.8 | Bug fix View pull request Add storage_account_container option to the Application Gateway integration |
1.5.7 | Bug fix View pull request Fix parsing of authentication_processing_details field in signin logs |
1.5.6 | Bug fix View pull request Fix parsing error client port is blank and adjust for timeStamp |
1.5.5 | Bug fix View pull request Rename identity as identity_name when the value is a string |
1.5.4 | Enhancement View pull request Enable Event Hub integration by default and improve documentation |
1.5.3 | Enhancement View pull request Data streams start as disabled on new installs |
1.5.2 | Bug fix View pull request Fix PR link in changelog |
1.5.1 | Bug fix View pull request Fix documentations formatting (remove extra 'Overview' heading) |
1.5.0 | Enhancement View pull request Add Azure Application Gatewaty data stream |
1.4.1 | Enhancement View pull request Update Azure Logs documentation |
1.4.0 | Enhancement View pull request Add two new data streams to the Azure AD logs integration: Azure Identity Protection logs and Provisioning logs |
1.3.0 | Enhancement View pull request Add the possibility to override the default generated storage account container |
1.2.3 | Enhancement View pull request Update docs with recommended Event Hub configuration |
1.2.2 | Enhancement View pull request Update package name and description to align with standard wording |
1.2.1 | Bug fix View pull request Fix Azure Sign-in logs ingest pipeline bug |
1.2.0 | Enhancement View pull request Support Azure firewall logs |
1.1.11 | Bug fix View pull request Improve support for event.original field from upstream forwarders. |
1.1.10 | Enhancement View pull request Update readme with links to Microsoft documentation |
1.1.9 | Bug fix View pull request Improve handling of IPv6 IP addresses. |
1.1.8 | Enhancement View pull request Update docs with details about Event Hub name recommendations |
1.1.7 | Bug fix View pull request Add geo.name and result_description fields in platformlogs |
1.1.6 | Bug fix View pull request Fix azure.activitylogs.identity with a a concrete value Bug fix View pull request Add identity_name, tenant_id, level and operation_version into activity logs |
1.1.5 | Enhancement View pull request Add documentation for multi-fields |
1.1.4 | Bug fix View pull request Fix event.duration field mapping conflict in all Azure data streams. |
1.1.3 | Enhancement View pull request Added the forwarded tag by default to all log types. |
1.1.2 | Bug fix View pull request Add device_detail.is_compliant and device_detail.is_managed fields Bug fix View pull request Change authentication_requirement_policies to flattened type |
1.1.1 | Bug fix View pull request Fix field mapping conflict in the auditlogs data stream for client.ip . Changed azure-eventhub.offset and azure-eventhub.sequence_number to longs from keyword in the eventhub data stream. |
1.1.0 | Enhancement View pull request Support new Azure audit logs and signin logs |
1.0.1 | Enhancement View pull request Remove beta release tag from data streams |
1.0.0 | Enhancement View pull request Move azure package to GA |
0.12.3 | Enhancement View pull request Update to ECS 8.0 |
0.12.2 | Bug fix View pull request Regenerate test files using the new GeoIP database |
0.12.1 | Bug fix View pull request Change test public IPs to the supported subset |
0.12.0 | Enhancement View pull request Release azure package for v8.0.0 |
0.11.0 | Enhancement View pull request Add Azure Event Hub Input |
0.10.1 | Enhancement View pull request Uniform with guidelines |
0.10.0 | Enhancement View pull request signinlogs - Add support for ManagedIdentitySignInLogs, NonInteractiveUserSignInLogs, and ServicePrincipalSignInLogs. |
0.9.2 | Bug fix View pull request Prevent pipeline script error |
0.9.1 | Bug fix View pull request Fix logic that checks for the 'forwarded' tag |
0.9.0 | Enhancement View pull request Update to ECS 1.12.0 |
0.8.6 | Bug fix View pull request Add ECS client.ip mapping |
0.8.5 | Enhancement View pull request Update docs and logo |
0.8.4 | Enhancement View pull request Convert to generated ECS fields |
0.8.3 | Enhancement View pull request Import geo_points from ECS |
0.8.2 | Enhancement View pull request Update error message |
0.8.1 | Enhancement View pull request Add support for springcloud logs inside the platformlogs pipeline |
0.8.0 | Enhancement View pull request Import ECS field definitions |
0.7.0 | Enhancement View pull request Add spring cloud logs |
0.6.2 | Enhancement View pull request update to ECS 1.11.0 |
0.6.1 | Enhancement View pull request Escape special characters in docs |
0.6.0 | Enhancement View pull request Update integration description |
0.5.1 | Enhancement View pull request Re-add pipeline changes for invalid json |
0.5.0 | Enhancement View pull request Add input groups |
0.4.0 | Enhancement View pull request Set "event.module" and "event.dataset" |
0.3.1 | Enhancement View pull request sync package with module changes |
0.3.0 | Enhancement View pull request update to ECS 1.10.0 and adding event.original options |
0.2.3 | Enhancement View pull request update to ECS 1.9.0 |
0.2.2 | Bug fix View pull request Correct sample event file. |
0.2.1 | Bug fix View pull request Add check for empty configuration options. |
0.2.0 | Enhancement View pull request Add changes to use ECS 1.8 fields. |
0.0.1 | Enhancement View pull request initial release |