Skip to content

Commit

Permalink
Frances Overby: Merge pull request #981 from coligo/fmo-upd-30Mar21-c
Browse files Browse the repository at this point in the history
  • Loading branch information
alchemyDocs committed Mar 30, 2021
1 parent 4a9e344 commit 3c0878f
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 27 deletions.
10 changes: 4 additions & 6 deletions at-events.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
copyright:
years: 2021
lastupdated: "2021-02-02"
lastupdated: "2021-03-30"

keywords: events, serverless, code engine, activity tracker

Expand Down Expand Up @@ -72,8 +72,6 @@ subcollection: codeengine
{:step: data-tutorial-type='step'}
{:subsection: outputclass="subsection"}
{:support: data-reuse='support'}
{:swift-ios: .ph data-hd-programlang='iOS Swift'}
{:swift-server: .ph data-hd-programlang='server-side Swift'}
{:swift: .ph data-hd-programlang='swift'}
{:swift: data-hd-programlang="swift"}
{:table: .aria-labeledby="caption"}
Expand Down Expand Up @@ -313,7 +311,7 @@ Note:
## Viewing events
{: #view}

{{site.data.keyword.codeenginefull_notm}} sends audit logs to the [{{site.data.keyword.at_full_notm}}](/docs/Activity-Tracker-with-LogDNA?topic=Activity-Tracker-with-LogDNA-getting-started) service in the same region as the {{site.data.keyword.codeenginefull_notm}} project. For example, audit logs in 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](/docs/Activity-Tracker-with-LogDNA?topic=Activity-Tracker-with-LogDNA-provision).
{{site.data.keyword.codeenginefull_notm}} sends audit logs to the [{{site.data.keyword.at_full_notm}}](/docs/Activity-Tracker-with-LogDNA?topic=Activity-Tracker-with-LogDNA-getting-started) service in the same region as the {{site.data.keyword.codeenginefull_notm}} project. For example, audit logs in an {{site.data.keyword.codeenginefull_notm}} project in `us-south` are sent to a logging instance in `us-south`. For more information about setting up {{site.data.keyword.at_full_notm}}, see [Provisioning an instance](/docs/Activity-Tracker-with-LogDNA?topic=Activity-Tracker-with-LogDNA-provision).

## Analyzing events
{: #at_events_analyze}
Expand All @@ -323,7 +321,7 @@ After you view events that are captured by {{site.data.keyword.at_full_notm}}, y

**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.
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 {{site.data.keyword.loganalysisshort_notm}}, for example, showing events for only a specific project.

You can use the CLI to find details about your [project](/docs/codeengine?topic=codeengine-manage-project).

Expand All @@ -339,4 +337,4 @@ All events that are issued for failed actions display `failure` in the `outcome`

**Custom views**

For more information about generating custom views by using event fields, see [Creating custom views in LogDNA](/docs/Activity-Tracker-with-LogDNA?topic=Activity-Tracker-with-LogDNA-views).
For more information about generating custom views by using event fields, see [Creating custom views in {{site.data.keyword.loganalysislong_notm}}](/docs/Activity-Tracker-with-LogDNA?topic=Activity-Tracker-with-LogDNA-views).
6 changes: 3 additions & 3 deletions cmd_defs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

copyright:
years: 2021
lastupdated: "2021-03-29"
lastupdated: "2021-03-30"

keywords: cli for code engine, command-line interface for code engine, cli commands for code engine, reference for code engine cli, ibmcloud ce, ibmcloud codeengine

Expand Down Expand Up @@ -3822,7 +3822,7 @@ This value is *optional*. </dd>
<dt>`--path`</dt>
<dd>The path within the `destination` application where events are forwarded; for example, `/events`. The default path is the root URL of the `destination` application. This value is *optional*. The default value is <code>/</code>.</dd>
<dt>`--schedule`, `-s`</dt>
<dd>Schedule how often the event is triggered, in crontab format. For example, specify `'*/2 * * * *'` (in string format) for every two minutes. By default, the ping event is triggered every minute and is set to the `UTC` timezone. To modify the time zone, use the `--time-zone` option. This value is *optional*.
<dd>Schedule how often the event is triggered, in crontab format. For example, specify `'*/2 * * * *'` (in string format) for every two minutes. By default, the ping event is triggered every minute and is set to the `UTC` time zone. To modify the time zone, use the `--time-zone` option. This value is *optional*.
</dd>
<dt>`--time-zone`, `--tz`</dt>
<dd>Set the time zone for your ping event; for example, `Asia/Tokyo`. If you specify the `--schedule` option, use this option to specify the time zone. For valid time zone values, see the TZ database name at `https://en.wikipedia.org/wiki/List_of_tz_database_time_zones`. This value is *optional*. The default value is <code>UTC</code>.
Expand Down Expand Up @@ -4021,7 +4021,7 @@ This value is *optional*. </dd>
<dt>`--path`</dt>
<dd>The path within the `destination` application where events are forwarded; for example, `/events`. The default path is the root URL of the `destination` application. This value is *optional*. </dd>
<dt>`--schedule`, `-s`</dt>
<dd>Schedule how often the event is triggered, in crontab format. For example, specify `'*/2 * * * *'` (in string format) for every two minutes. By default, the ping event is triggered every minute and is set to the `UTC` timezone. To modify the time zone, use the `--time-zone` option. This value is *optional*.
<dd>Schedule how often the event is triggered, in crontab format. For example, specify `'*/2 * * * *'` (in string format) for every two minutes. By default, the ping event is triggered every minute and is set to the `UTC` time zone. To modify the time zone, use the `--time-zone` option. This value is *optional*.
</dd>
<dt>`--time-zone`, `--tz`</dt>
<dd>Set the time zone for your ping event; for example, `Asia/Tokyo`. If you specify the `--schedule` option, use this option to specify the time zone. For valid time zone values, see the TZ database name at `https://en.wikipedia.org/wiki/List_of_tz_database_time_zones`. This value is *optional*.
Expand Down
36 changes: 18 additions & 18 deletions logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

copyright:
years: 2021
lastupdated: "2021-03-16"
lastupdated: "2021-03-30"

keywords: logging for code engine, logs for code engine, job logs for code engine, app logs for code engine, build logs for code engine

Expand Down Expand Up @@ -117,38 +117,38 @@ When you use the {{site.data.keyword.loganalysisshort_notm}} free tier, be sure

When you use a {{site.data.keyword.loganalysisshort_notm}} paid tier, you do not need to leave your logging window open. Log data is preserved for a configurable amount of time, depending on your plan. You can adjust log filters and apply searches for past log entries.

Review the [service plan](/docs/Log-Analysis-with-LogDNA?topic=Log-Analysis-with-LogDNA-service_plans) information as you consider retention, search, and log usage needs.
Review the [service plan](/docs/Log-Analysis-with-LogDNA?topic=Log-Analysis-with-LogDNA-service_plans) information as you consider retention, search, and log analysis needs.
{: tip}

### Viewing app logs from the console
{: #view-applogs-ui}

1. Navigate to an app that you have created and deployed. From the [Projects page on the {{site.data.keyword.codeengineshort}} console](https://cloud.ibm.com/codeengine/projects){: external}, select your project and then select **Applications**. Select the app that you want to work with.
2. From your {{site.data.keyword.codeengineshort}} app page, you can add logging capabilities. If you have not previously created an {{site.data.keyword.loganalysislong_notm}} with LogDNA instance, in the **Test pane** area, **Add logging** displays. If you have previously created an {{site.data.keyword.loganalysislong_notm}} with LogDNA instance, in the **Test pane** area of your {{site.data.keyword.codeengineshort}} app page, **Launch logging** displays.
1. Click **Add logging** to create the {{site.data.keyword.loganalysislong_notm}} with LogDNA instance. This action opens the {{site.data.keyword.loganalysislong_notm}} with LogDNA service.
2. From {{site.data.keyword.loganalysislong_notm}} with LogDNA service, create your LogDNA instance. To confirm that your logging instance is created, check the [Observability dashboard](https://cloud.ibm.com/observe/logging).
3. From your {{site.data.keyword.codeengineshort}} app page, in the **Test pane** area, click **Add logging** again. This time, select an {{site.data.keyword.loganalysislong_notm}} with LogDNA instance to receive platform logs. {{site.data.keyword.codeengineshort}} requires platform logs be configured to receive {{site.data.keyword.codeengineshort}} logging data. Let's choose the LogDNA instance that was created in the prior step. Click **Select**.
4. Now that you have configured platform logging, from your {{site.data.keyword.codeengineshort}} app page, in the **Test pane**, the **Launch Logging** option is displayed. To confirm that platform logs are set for your region, check the [Observability dashboard](https://cloud.ibm.com/observe/logging). Click **Launch logging** to open your LogDNA platform logs window. Be sure to keep this platform logs window open to receive your logging data if you are using the {{site.data.keyword.loganalysisshort_notm}} free tier. You don't need to keep this window open if you are using a {{site.data.keyword.loganalysisshort_notm}} paid tier as log data is preserved for a configurable amount of time, depending on your plan.
5. Test your application. From the **Test pane**, click **Send request**. You can view platform logs from the test of your application in the LogDNA platform logs window.
2. From your {{site.data.keyword.codeengineshort}} app page, you can add logging capabilities. If you have not previously created an {{site.data.keyword.loganalysisshort_notm}} instance, in the **Test pane** area, **Add logging** displays. If you have previously created an {{site.data.keyword.loganalysisshort_notm}} instance, in the **Test pane** area of your {{site.data.keyword.codeengineshort}} app page, **Launch logging** displays.
1. Click **Add logging** to create the {{site.data.keyword.loganalysislong_notm}} instance. This action opens the {{site.data.keyword.loganalysisshort_notm}} service.
2. From {{site.data.keyword.loganalysisshort_notm}} service, create your logging instance. To confirm that your logging instance is created, check the [Observability dashboard](https://cloud.ibm.com/observe/logging).
3. From your {{site.data.keyword.codeengineshort}} app page, in the **Test pane** area, click **Add logging** again. This time, select an {{site.data.keyword.loganalysisshort_notm}} instance to receive platform logs. {{site.data.keyword.codeengineshort}} requires platform logs be configured to receive {{site.data.keyword.codeengineshort}} logging data. Let's choose the logging instance that was created in the prior step. Click **Select**.
4. Now that you have configured platform logging, from your {{site.data.keyword.codeengineshort}} app page, in the **Test pane**, the **Launch Logging** option is displayed. To confirm that platform logs are set for your region, check the [Observability dashboard](https://cloud.ibm.com/observe/logging). Click **Launch logging** to open your platform logs window. Be sure to keep this platform logs window open to receive your logging data if you are using the {{site.data.keyword.loganalysisshort_notm}} free tier. You don't need to keep this window open if you are using a {{site.data.keyword.loganalysisshort_notm}} paid tier as log data is preserved for a configurable amount of time, depending on your plan.
5. Test your application. From the **Test pane**, click **Send request**. You can view platform logs from the test of your application in the platform logs window.

You have completed the steps to configure your {{site.data.keyword.loganalysislong_notm}} with LogDNA instance such that it can receive platform logging for your {{site.data.keyword.codeengineshort}} app.
You have completed the steps to configure your {{site.data.keyword.loganalysisshort_notm}} instance such that it can receive platform logging for your {{site.data.keyword.codeengineshort}} app.

Alternatively, you can also configure an {{site.data.keyword.loganalysislong_notm}} with LogDNA instance by using the [Observability dashboard](https://cloud.ibm.com/observe/logging) to create the instance, and then by [configuring platform logs](/docs/Log-Analysis-with-LogDNA?topic=Log-Analysis-with-LogDNA-config_svc_logs#config_svc_logs_ui). After you create your instance, click **Configure platform logs**. Select the {{site.data.keyword.la_short}} instance to receive the platform log data by specifying a region and your log instance.
Alternatively, you can also configure an {{site.data.keyword.loganalysisshort_notm}} instance by using the [Observability dashboard](https://cloud.ibm.com/observe/logging) to create the instance, and then by [configuring platform logs](/docs/Log-Analysis-with-LogDNA?topic=Log-Analysis-with-LogDNA-config_svc_logs#config_svc_logs_ui). After you create your instance, click **Configure platform logs**. Select the {{site.data.keyword.loganalysisshort}} instance to receive the platform log data by specifying a region and your log instance.

### Viewing job logs from the console
{: #view-joblogs-ui}

1. Navigate to a job that you have created and deployed. From the [Projects page on the {{site.data.keyword.codeengineshort}} console](https://cloud.ibm.com/codeengine/projects){: external}, select your project and then select **Jobs**. Select the job that you want to work with.
2. From your {{site.data.keyword.codeengineshort}} job page, you can add logging capabilities. If you have not previously created an {{site.data.keyword.loganalysislong_notm}} with LogDNA instance, from the **Actions** menu, click **Add logging**. If you have previously created an {{site.data.keyword.loganalysislong_notm}} with LogDNA instance, the **Actions** menu displays **Launch logging** displays.
a. From the **Actions** menu, click **Add logging** to create the {{site.data.keyword.loganalysislong_notm}} with LogDNA instance. This action opens the {{site.data.keyword.loganalysislong_notm}} with LogDNA service.
b. From {{site.data.keyword.loganalysislong_notm}} with LogDNA service, create your LogDNA instance. To confirm that your logging instance is created, check the [Observability dashboard](https://cloud.ibm.com/observe/logging).
3. From your {{site.data.keyword.codeengineshort}} job page, in the **Actions** menu, click **Add logging** again. This time, select an {{site.data.keyword.loganalysislong_notm}} with LogDNA instance to receive platform logs. {{site.data.keyword.codeengineshort}} requires platform logs be configured to receive {{site.data.keyword.codeengineshort}} logging data. Let's choose the LogDNA instance that was created in the prior step. Click **Select**.
4. Now that you have configured platform logging, from your {{site.data.keyword.codeengineshort}} job page, from the **Actions** menu, click **Logging** to open your LogDNA platform logs window. Be sure to keep this platform logs window open to receive your logging data if you are using the {{site.data.keyword.loganalysisshort_notm}} free tier. Don't keep this window open if you are using a {{site.data.keyword.loganalysisshort_notm}} paid tier.
5. Run your job. From the **Job runs** area, click **Submit job** to run your job. Provide the job run configuration values or you can take the default values. Click **Submit job** to run your job. You can view platform logs from the test of your application in the LogDNA platform logs window.
2. From your {{site.data.keyword.codeengineshort}} job page, you can add logging capabilities. If you have not previously created an {{site.data.keyword.loganalysisshort_notm}} instance, from the **Actions** menu, click **Add logging**. If you have previously created an {{site.data.keyword.loganalysisshort_notm}} instance, the **Actions** menu displays **Launch logging** displays.
a. From the **Actions** menu, click **Add logging** to create the {{site.data.keyword.loganalysisshort_notm}} instance. This action opens the {{site.data.keyword.loganalysisshort_notm}} service.
b. From {{site.data.keyword.loganalysisshort_notm}} service, create your logging instance. To confirm that your logging instance is created, check the [Observability dashboard](https://cloud.ibm.com/observe/logging).
3. From your {{site.data.keyword.codeengineshort}} job page, in the **Actions** menu, click **Add logging** again. This time, select an {{site.data.keyword.loganalysisshort_notm}} instance to receive platform logs. {{site.data.keyword.codeengineshort}} requires platform logs be configured to receive {{site.data.keyword.codeengineshort}} logging data. Let's choose the logging instance that was created in the prior step. Click **Select**.
4. Now that you have configured platform logging, from your {{site.data.keyword.codeengineshort}} job page, from the **Actions** menu, click **Logging** to open your platform logs window. Be sure to keep this platform logs window open to receive your logging data if you are using the {{site.data.keyword.loganalysisshort_notm}} free tier. Don't keep this window open if you are using a {{site.data.keyword.loganalysisshort_notm}} paid tier.
5. Run your job. From the **Job runs** area, click **Submit job** to run your job. Provide the job run configuration values or you can take the default values. Click **Submit job** to run your job. You can view platform logs from the test of your application in the platform logs window.

You have completed the steps to configure your {{site.data.keyword.loganalysislong_notm}} with LogDNA instance such that it can receive platform logging for your {{site.data.keyword.codeengineshort}} job.
You have completed the steps to configure your {{site.data.keyword.loganalysisshort_notm}} instance such that it can receive platform logging for your {{site.data.keyword.codeengineshort}} job.

Alternatively, you can also configure an {{site.data.keyword.loganalysislong_notm}} with LogDNA instance by using the [Observability dashboard](https://cloud.ibm.com/observe/logging) to create the instance, and then by [configuring platform logs](/docs/Log-Analysis-with-LogDNA?topic=Log-Analysis-with-LogDNA-config_svc_logs#config_svc_logs_ui). After you create your instance, click **Configure platform logs**. Select the {{site.data.keyword.la_short}} instance to receive the platform log data by specifying a region and your log instance.
Alternatively, you can also configure an {{site.data.keyword.loganalysisshort_notm}} instance by using the [Observability dashboard](https://cloud.ibm.com/observe/logging) to create the instance, and then by [configuring platform logs](/docs/Log-Analysis-with-LogDNA?topic=Log-Analysis-with-LogDNA-config_svc_logs#config_svc_logs_ui). After you create your instance, click **Configure platform logs**. Select the {{site.data.keyword.la_short}} instance to receive the platform log data by specifying a region and your log instance.

## Viewing application logs with the CLI
{: #view-applog-cli}
Expand Down

0 comments on commit 3c0878f

Please sign in to comment.