api.ibm

[ 1 Introduction ] [ 2 Valid tags and data tables ] [ 3 Table structure ]

Introduction

The tags beginning with api.ibm identify events generated by APIs belonging to IBM.

Valid tags and data tables

The full tag must have 4 levels. The first two are fixed as api.ibm. The third level identifies the type of events sent. The fourth level indicates the event subtype.

These are the valid tags and corresponding data tables that will receive the parsers' data:

Product / Service	Tags	Data tables

Product / Service	Tags	Data tables
IBM API Connect	`api.ibm.connect.audit`	`api.ibm.connect.audit`
IBM API Connect	`api.ibm.connect.event`	`api.ibm.connect.event`

For more information, read more About Devo tags.

Table structure

These are the fields displayed in these tables:

api.ibm.connect.audit
api.ibm.connect.event

api.ibm.connect.audit

Field	Type	Field transformation	Source field name	Extra fields

Field	Type	Field transformation	Source field name	Extra fields
eventdate	`timestamp`
hostname	`str`		vhost
cluster	`str`	`split(tag, '.', 4)`	tag
instance	`str`	`split(tag, '.', 5)`	tag
eventType	`str`
timestamp	`str`
version	`str`
assetId	`str`
assetType	`str`
client_geoip_area_code	`int4`
client_geoip_city_name	`str`
client_geoip_continent_code	`str`
client_geoip_country_code2	`str`
client_geoip_country_code3	`str`
client_geoip_country_name	`str`
client_geoip_dma_code	`int4`
client_geoip_ip	`ip4`
client_geoip_latitude	`float8`
client_geoip_location	`str`
client_geoip_longitude	`float8`
client_geoip_postal_code	`str`
client_geoip_real_region_name	`str`
client_geoip_region_name	`str`
client_geoip_timezone	`str`
consumerOrgId	`str`
datetime	`str`
envId	`str`
gateway_geoip_area_code	`int4`
gateway_geoip_city_name	`str`
gateway_geoip_continent_code	`str`
gateway_geoip_country_code2	`str`
gateway_geoip_country_code3	`str`
gateway_geoip_country_name	`str`
gateway_geoip_dma_code	`int4`
gateway_geoip_ip	`ip4`
gateway_geoip_latitude	`float8`
gateway_geoip_location	`str`
gateway_geoip_longitude	`float8`
gateway_geoip_postal_code	`str`
gateway_geoip_real_region_name	`str`
gateway_geoip_region_name	`str`
gateway_geoip_timezone	`str`
headers_http_host	`str`
headers_http_accept	`str`
headers_http_version	`str`
headers_http_connection	`str`
headers_http_user_agent	`str`
headers_content_type	`str`
headers_content_length	`str`
headers_request_path	`str`
headers_request_method	`str`
headers_request_uri	`str`
host	`str`
id	`str`
message	`str`
nlsMessage_key	`str`
nlsMessage_resource	`str`
nlsMessage_replacements_str	`str`	`join(nlsMessage_replacements, ",")`	nlsMessage_replacements
notificationType	`str`
orgId	`str`
source	`str`
tags_str	`str`		tags
userId	`str`
hostchain	`str`			✓
tag	`str`			✓
rawMessage	`str`			✓

api.ibm.connect.event

Field	Type	Field transformation	Source field name	Extra fields

Field	Type	Source field name	Extra fields
eventdate	`timestamp`
hostname	`str`	vhost
cluster	`str`	tag
instance	`str`	tag
timestamp	`str`
version	`str`
api_id	`str`
api_name	`str`
api_version	`str`
app_id	`str`
app_name	`str`
app_type	`str`
billing_amount	`int8`
billing_currency	`str`
billing_model	`str`
billing_provider	`str`
billing_trial_period_days	`int8`
bytes_received	`int8`
bytes_sent	`int8`
catalog_id	`str`
catalog_name	`str`
client_geoip_area_code	`int4`
client_geoip_city_name	`str`
client_geoip_continent_code	`str`
client_geoip_country_code2	`str`
client_geoip_country_code3	`str`
client_geoip_country_name	`str`
client_geoip_dma_code	`int4`
client_geoip_ip	`ip4`
client_geoip_latitude	`float8`
client_geoip_location_str	`str`	client_geoip_location
client_geoip_longitude	`float8`
client_geoip_postal_code	`str`
client_geoip_real_region_name	`str`
client_geoip_region_name	`str`
client_geoip_region_code	`str`
client_geoip_timezone	`str`
client_id	`str`
client_ip	`ip4`
datetime	`str`
developer_org_id	`str`
developer_org_name	`str`
endpoint_url	`str`
env_id	`str`
env_name	`str`
gateway_geoip_area_code	`int4`
gateway_geoip_city_name	`str`
gateway_geoip_continent_code	`str`
gateway_geoip_country_code2	`str`
gateway_geoip_country_code3	`str`
gateway_geoip_country_name	`str`
gateway_geoip_dma_code	`int4`
gateway_geoip_ip	`ip4`
gateway_geoip_latitude	`float8`
gateway_geoip_location_str	`str`	client_geoip_location
gateway_geoip_longitude	`float8`
gateway_geoip_postal_code	`str`
gateway_geoip_real_region_name	`str`
gateway_geoip_region_name	`str`
gateway_geoip_region_code	`str`
gateway_geoip_timezone	`str`
gateway_ip	`ip4`
headers_content_length	`str`
headers_content_type	`str`
headers_http_connection	`str`
headers_http_host	`str`
headers_http_organization	`str`
headers_http_version	`str`
headers_http_via	`str`
headers_http_x_client_ip	`ip4`
headers_http_x_forwarded_host	`str`
headers_http_x_forwarded_for	`str`
headers_http_x_forwarded_server	`str`
headers_http_x_global_transaction_id	`str`
headers_http__ws_haprt_wlmversion	`str`
headers_request_method	`str`
headers_request_path	`str`
headers_request_uri	`str`
host	`str`
http_user_agent	`str`
immediate_client_ip	`ip4`
latency_info_started_str	`str`	latency_info_started
latency_info_task_str	`str`	latency_info_task
latency_info2_started_str	`str`	latency_info2_started
latency_info2_task_str	`str`	latency_info2_task
log_policy	`str`
org_id	`str`
org_name	`str`
plan_id	`str`
plan_name	`str`
plan_version	`str`
product_name	`str`
product_title	`str`
product_version	`str`
query_string_str	`str`	query_string
rateLimit_rate_limit_limit	`str`
rateLimit_rate_limit_count	`str`
rateLimit_rate_limit_1_limit	`str`
rateLimit_rate_limit_1_count	`str`
rateLimit_rate_limit_2_limit	`str`
rateLimit_rate_limit_2_count	`str`
rateLimit_per_minute_limit	`str`
rateLimit_per_minute_count	`str`
request_body	`str`
request_http_headers_accept_str	`str`	request_http_headers_accept
request_http_headers_accept_encoding_str	`str`	request_http_headers_accept_encoding
request_http_headers_host_str	`str`	request_http_headers_host
request_http_headers_user_agent_str	`str`	request_http_headers_user_agent
request_http_headers_via_str	`str`	request_http_headers_via
request_http_headers_x_client_ip_str	`str`	request_http_headers_x_client_ip
request_http_headers_x_global_transaction_id_str	`str`	request_http_headers_x_global_transaction_id
request_http_headers_x_lbx_trace_id_str	`str`	request_http_headers_x_lbx_trace_id
request_http_headers_user_fingerprint_str	`str`	request_http_headers_user_fingerprint
request_method	`str`
request_protocol	`str`
resource	`str`
resource_id	`str`
resource_path	`str`
response_body	`str`
response_http_headers_accept_str	`str`	response_http_headers_accept
response_http_headers_accept_encoding_str	`str`	response_http_headers_accept_encoding
response_http_headers_access_control_allow_credentials_str	`str`	response_http_headers_access_control_allow_credentials
response_http_headers_access_control_allow_methods_str	`str`	response_http_headers_access_control_allow_methods
response_http_headers_access_control_allow_origin_str	`str`	response_http_headers_access_control_allow_origin
response_http_headers_access_control_expose_headers_str	`str`	response_http_headers_access_control_expose_headers
response_http_headers_content_type_str	`str`	response_http_headers_content_type
response_http_headers_date_str	`str`	response_http_headers_date
response_http_headers_user_agent_str	`str`	response_http_headers_user_agent
response_http_headers_via_str	`str`	response_http_headers_via
response_http_headers_x_client_ip_str	`str`	response_http_headers_x_client_ip
response_http_headers_x_global_transaction_id_str	`str`	response_http_headers_x_global_transaction_id
status_code	`str`
tags_str	`str`	tags
time_to_serve_request	`int8`
transaction_id	`str`
uri_path	`str`
space_id_str	`str`	space_id
space_name_str	`str`	space_name
developer_org_title	`str`
hostchain	`str`		✓
tag	`str`		✓
rawMessage	`str`		✓