Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Atlassian Jira Readme #3063

Merged
merged 10 commits into from
Apr 14, 2022
Merged
2 changes: 1 addition & 1 deletion packages/atlassian_jira/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Atlassian Jira Integration

The Jira integration collects audit logs from the audit log files or the audit API.
The Jira integration collects audit logs from the audit log files or the [audit API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-audit-records/).
ellis-elastic marked this conversation as resolved.
Show resolved Hide resolved

## Logs

Expand Down
5 changes: 5 additions & 0 deletions packages/atlassian_jira/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.1.2"
changes:
- description: Updarte Readme
ellis-elastic marked this conversation as resolved.
Show resolved Hide resolved
type: enhancement
link: https://github.com/elastic/integrations/pull/3063
- version: "1.1.1"
changes:
- description: Add documentation for multi-fields
Expand Down
10 changes: 1 addition & 9 deletions packages/atlassian_jira/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Atlassian Jira Integration

The Jira integration collects audit logs from the audit log files or the audit API.
The Jira integration collects audit logs from the audit log files or the [audit API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-audit-records/).

## Logs

Expand Down Expand Up @@ -47,7 +47,6 @@ The Jira integration collects audit logs from the audit log files or the audit A
| 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`. | 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 |
Expand All @@ -71,7 +70,6 @@ The Jira integration collects audit logs from the audit log files or the audit A
| 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.bytes | Bytes sent from the source to the destination. | long |
| source.domain | The domain name of the source system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. | keyword |
| source.geo.city_name | City name. | keyword |
Expand All @@ -86,21 +84,15 @@ The Jira integration collects audit logs from the audit log files or the audit A
| tags | List of keywords used to tag each event. | keyword |
| user.changes.email | User email address. | keyword |
| user.changes.full_name | User's full name, if available. | keyword |
| user.changes.full_name.text | Multi-field of `user.changes.full_name`. | match_only_text |
| user.changes.name | Short name or login of the user. | keyword |
| user.changes.name.text | Multi-field of `user.changes.name`. | match_only_text |
| 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 |
| user.target.email | User email address. | keyword |
| user.target.full_name | User's full name, if available. | keyword |
| user.target.full_name.text | Multi-field of `user.target.full_name`. | match_only_text |
| user.target.group.name | Name of the group. | keyword |
| user.target.id | Unique identifier of the user. | keyword |
| user.target.name | Short name or login of the user. | keyword |
| user.target.name.text | Multi-field of `user.target.name`. | match_only_text |


An example event for `audit` looks as following:
Expand Down
2 changes: 1 addition & 1 deletion packages/atlassian_jira/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
format_version: 1.0.0
name: atlassian_jira
title: Atlassian Jira
version: 1.1.1
version: 1.1.2
license: basic
description: Collect logs from Atlassian Jira with Elastic Agent.
type: integration
Expand Down