Skip to content

Latest commit

 

History

History
612 lines (556 loc) · 16.6 KB

at-events.md

File metadata and controls

612 lines (556 loc) · 16.6 KB
copyright lastupdated keywords subcollection
years
2021
2021-01-20
events, serverless, codeengine, activity tracker
codeengine

{:DomainName: data-hd-keyref="APPDomain"} {:DomainName: data-hd-keyref="DomainName"} {:android: data-hd-operatingsystem="android"} {:api: .ph data-hd-interface='api'} {:apikey: data-credential-placeholder='apikey'} {:app_key: data-hd-keyref="app_key"} {:app_name: data-hd-keyref="app_name"} {:app_secret: data-hd-keyref="app_secret"} {:app_url: data-hd-keyref="app_url"} {:authenticated-content: .authenticated-content} {:beta: .beta} {:c#: data-hd-programlang="c#"} {:cli: .ph data-hd-interface='cli'} {:codeblock: .codeblock} {:curl: .ph data-hd-programlang='curl'} {:deprecated: .deprecated} {:dotnet-standard: .ph data-hd-programlang='dotnet-standard'} {:download: .download} {:external: target="_blank" .external} {:faq: data-hd-content-type='faq'} {:fuzzybunny: .ph data-hd-programlang='fuzzybunny'} {:generic: data-hd-operatingsystem="generic"} {:generic: data-hd-programlang="generic"} {:gif: data-image-type='gif'} {:go: .ph data-hd-programlang='go'} {:help: data-hd-content-type='help'} {:hide-dashboard: .hide-dashboard} {:hide-in-docs: .hide-in-docs} {:important: .important} {:ios: data-hd-operatingsystem="ios"} {:java: .ph data-hd-programlang='java'} {:java: data-hd-programlang="java"} {:javascript: .ph data-hd-programlang='javascript'} {:javascript: data-hd-programlang="javascript"} {:new_window: target="_blank"} {:note .note} {:note: .note} {:objectc data-hd-programlang="objectc"} {:org_name: data-hd-keyref="org_name"} {:php: data-hd-programlang="php"} {:pre: .pre} {:preview: .preview} {:python: .ph data-hd-programlang='python'} {:python: data-hd-programlang="python"} {:route: data-hd-keyref="route"} {:row-headers: .row-headers} {:ruby: .ph data-hd-programlang='ruby'} {:ruby: data-hd-programlang="ruby"} {:runtime: architecture="runtime"} {:runtimeIcon: .runtimeIcon} {:runtimeIconList: .runtimeIconList} {:runtimeLink: .runtimeLink} {:runtimeTitle: .runtimeTitle} {:screen: .screen} {:script: data-hd-video='script'} {:service: architecture="service"} {:service_instance_name: data-hd-keyref="service_instance_name"} {:service_name: data-hd-keyref="service_name"} {:shortdesc: .shortdesc} {:space_name: data-hd-keyref="space_name"} {:step: data-tutorial-type='step'} {:subsection: outputclass="subsection"} {:support: data-reuse='support'} {:swift: .ph data-hd-programlang='swift'} {:swift: data-hd-programlang="swift"} {:table: .aria-labeledby="caption"} {:term: .term} {:tip: .tip} {:tooling-url: data-tooling-url-placeholder='tooling-url'} {:troubleshoot: data-hd-content-type='troubleshoot'} {:tsCauses: .tsCauses} {:tsResolve: .tsResolve} {:tsSymptoms: .tsSymptoms} {:tutorial: data-hd-content-type='tutorial'} {:ui: .ph data-hd-interface='ui'} {:unity: .ph data-hd-programlang='unity'} {:url: data-credential-placeholder='url'} {:user_ID: data-hd-keyref="user_ID"} {:vbnet: .ph data-hd-programlang='vb.net'} {:video: .video}

Viewing {{site.data.keyword.cloudaccesstrailshort}} events

{: #activity_tracker}

You can view, manage, and audit user-initiated activities made in your {{site.data.keyword.codeenginefull}} service instance by using the {{site.data.keyword.at_full_notm}} service. {: shortdesc}

{{site.data.keyword.at_full_notm}} records user-initiated activities that change the state of a service in {{site.data.keyword.cloud_notm}}. You can use this service to investigate abnormal activity and critical actions and to follow regulatory audit requirements. You can also be alerted about actions as they happen. The events that are collected follow the Cloud Auditing Data Federation (CADF) standard. For more information, see the Getting Started tutorial for {{site.data.keyword.at_full_notm}}.

List of events

{: #events}

The following list of {{site.data.keyword.codeenginefull}} events is sent to {{site.data.keyword.at_full_notm}}. {: shortdesc}

List of events from IBM Cloud console and CLI actions

The following events are generated when an initiator interacts with the {{site.data.keyword.codeenginefull_notm}} console and CLI or with the kubectl and kn commands.

project events

Action Description
codeengine.project.create Create a project.
codeengine.project.read Get or list projects.
codeengine.project.update Update a project.
codeengine.project.delete Delete a project.
codeengine.projectconfig.read Get a project `kubeconfig`.

application events

Action Description
codeengine.application.create Create an application in project.
codeengine.application.read Get an application.
codeengine.application.list List applications.
codeengine.application.update Update an application.
codeengine.application.delete Delete one or more applications.

configmap events

Action Description
codeengine.configmap.create Create a configmap in project.
codeengine.configmap.read Get a configmap.
codeengine.configmap.list List configmaps.
codeengine.configmap.update Update a configmap.
codeengine.configmap.delete Delete one or more configmaps.

secret events

Action Description
codeengine.secret.create Create a secret in project.
codeengine.secret.read Get a secret.
codeengine.secret.list List secrets.
codeengine.secret.update Update a secret.
codeengine.secret.delete Delete one or more secrets.

build and buildrun events

Action Description
codeengine.build.create Create a build in project.
codeengine.build.read Get a build.
codeengine.build.list List builds.
codeengine.build.update Update a build.
codeengine.build.delete Delete one or more builds.
codeengine.buildrun.create Submit a build run in project.
codeengine.buildrun.read Get a build run.
codeengine.buildrun.list List build runs.
codeengine.buildrun.delete Delete one or more build runs.

job and jobrun events

Action Description
codeengine.job.create Create a job in project.
codeengine.job.read Get a job.
codeengine.job.list List jobs.
codeengine.job.update Update a job.
codeengine.job.delete Delete one or more jobs.
codeengine.jobrun.create Submit a job run.
codeengine.jobrun.read Get a job run.
codeengine.jobrun.list List job runs.
codeengine.jobrun.delete Delete one or more job runs.

subscription events

Action Description
codeengine.subscription.create Create an event source in project.
codeengine.subscription.read Get a event source.
codeengine.subscription.list List event sources.
codeengine.subscription.update Update an event source.
codeengine.subscription.delete Delete one or more event sources.

List of events from kubectl and kn commands

The following events are generated when an initiator interacts with the kubectl and kn commands.

pods events

Action Description
codeengine.pods.create Create a pod in project.
codeengine.pods.read Get a pod.
codeengine.pods.list List pods.
codeengine.pods.update Update a pod.
codeengine.pods.delete Delete a pod.

serviceaccounts events

Action Description
codeengine.serviceaccounts.read Get a serviceaccount.
codeengine.serviceaccounts.list List serviceaccounts.

events events

Action Description
codeengine.events.read Get a event.
codeengine.events.list List events.

resourcequotas events

Action Description
codeengine.resourcequotas.read Get a resourcequota.
codeengine.resourcequotas.list List resourcequotas.

limitranges events

Action Description
codeengine.limitranges.read Get a limitrange.
codeengine.limitranges.list List limitranges.

deployments events

Action Description
codeengine.deployments.read Get a deployment.
codeengine.deployments.list List deployments.

servicebindings events

Action Description
codeengine.servicebindings.create Create a servicebinding in project.
codeengine.servicebindings.read Get a servicebinding.
codeengine.servicebindings.list List servicebindings.
codeengine.servicebindings.update Update a servicebinding.
codeengine.servicebindings.delete Delete a servicebinding.

Note:

  • Update event does not include original value, it only includes new value provided in request body. To get original value, you can run read action before update action.
  • requestData includes request body and verb of action.
  • responseData includes response body of action.
  • For some actions, for example codeengine.pods.list or codeengine.pods.get actions, the event length may exceeds 16K, so we will set responseData to Information about the action is not included for performance and size reasons. if message length exceeds 16K.

Viewing events

{: #view}

{{site.data.keyword.codeenginefull_notm}} sends audit logs to the {{site.data.keyword.at_full_notm}} service of the same region as the {{site.data.keyword.codeenginefull_notm}} project. For example, audit logs of an {{site.data.keyword.codeenginefull_notm}} project in us-south are sent to a LogDNA instance in us-south. For more information about setting up {{site.data.keyword.at_full_notm}}, see Provisioning an instance.

Analyzing events

{: #at_events_analyze}

After viewing events that are captured by {{site.data.keyword.at_full_notm}}, you can then analyze the events. {: shortdesc}

Identifying the {{site.data.keyword.codeengineshort}} project that generates the event.

To identify the project for which the event was generated, look at the target.id field. You can use this field to filter events in LogDNA, for example, showing events for only a specific project.

You can use the CLI to find details about your project.

Getting the unique ID of a request

Each action that you perform on a {{site.data.keyword.codeengineshort}} project resource has a unique ID.

To find the unique ID of a request, look at the correlationId value that is set in the correlationId field.

Getting information for failures

All events that are issued for failed actions display failure in the outcome field, and in addition provide more details as part of the reason field. Note that the reason.reasonForFailure field might be especially helpful, as it contains details of the failure.

Custom views

For more information about generating custom views by using event fields, see Creating custom views in LogDNA.