Okta Beat Collection
This section provides instructions to initialize the Okta Beat after configuration. Its primary focus is to pull the system log from Okta cloud.
Prerequisites
Before initializing the Okta Beat, do the following:
- Make sure that the customer is an LRCloud customer and has their environment hosted.
- Check if the Open Collector has been installed in the customer's LRCloud environment on a separate instance. If not, an Open Collector instance must be requested via a support case.
- Ensure that the Open Collector log source has been accepted and configured for log source virtualization.
- Make sure that you have the Okta Cloud domain name. You can get this from the Okta Developer Console. For more information, see https://developer.okta.com/docs/guides/find-your-domain/findorg/.
Check if you have the Okta Cloud API Token. If you do not have this Token, see https://developer.okta.com/docs/guides/create-an-api-token/create-the-token/.
Apply the Log Source Virtualization Template
- Log in to the Client Console in Cameyo.
- Click Deployment Manager from the toolbar.
- Click the Log Sources tab.
- Double-click the required Open Collector Log Source (such as, {instance}-opencollector.c.e3-hub-753dd405.internal Open Collector).
The Log Message Source Properties window appears. - Click the Log Source Virtualization tab.
- If not checked, select the Enable Virtualization check box.
- Click Create Virtual Log Sources.
The Create Virtual Log Sources dialog box appears. - In the Virtual Log Sources menu, check the Action check box corresponding to "Syslog - Open Collector - Okta System Log" and "Syslog - Open Collector - OktaSystemLogBeat Heartbeat" log source types.
- Click Save.
The Virtual Log Source(s) created prompt appears. - Click Ok.
- Click Apply.
- Click Ok.
The new Log Sources will appear in the grid as children of your parent log source. - Click the System Monitors tab.
- Select the Action check box corresponding to the (customerid)-dpawc agent.
- Right-click the selection, click Actions and then click Service Restart.
Initialize the Beat
- Log in to the Web Console as a Restricted Administrator User.
- On the top navigation bar, click the Administration icon and select Cloud Log Collection.
- At the top of the Cloud Log Collection page, click New Log Source.
The New cloud log collection dialog box appears. - Select the Okta Beat - Open Collector tile.
The Add Okta Beat Log Source window appears. Enter the following details:
Setting
Description
Name Enter the name for this log source. Description (Optional) Enter a description for this log source. Okta Domain Enter the Okta Domain (for example, dev-1234567-admin.okta.com).
API Key Enter the Okta API Key (for example, 01234abcde_01234abcde01234abcde01234abcdef)
- Click Save.
- Log in to the Client Console in Cameyo.
- Click Deployment Manager from the toolbar.
- Click the System Monitors tab.
- Select the Action check box corresponding to the dpwac agent.
- Right-click the selection, click Actions and then click Service Restart.
A new log source is created with the provided information based on the virtualized log source that was already created. Collection should start automatically in few minutes.
The Open Collector hosts the log sources. It is recommended to create a new host entity and move the log source to the new host which is done in the log source properties screen and not from the log source grid.
For security, the values entered are encrypted using LRCrypt.
Default Config Values for Okta Beat
Setting | Field Name | Default Values |
---|---|---|
1 | heartbeatinterval | 60s |
2 | heartbeatdisabled | false |
3 | period | 2s |
4 | throttlingIntervalSecs: | 60 |
5 | numbackdaysData | 7
Number of back days must be a non-negative number.
Okta beat supports only 180 days back log data. Therefore, the range for this value is 1-180 days. |
6 | limit | 1000
Supported limit range is 1-1000.
|