OMS - Cloud Foundry Solution

Browse code

Version: 2018.6

Overview

This solution allows you to visualize and monitor the metrics and logs from your Cloud Foundry environments in OMS Log Analytics.

In order to use this solution, you must have

1. A Cloud Foundry deployment
2. The Azure Log Analytics Firehose Nozzle deployed to your Cloud Foundry environment.
3. (Optional, recommended) The Microsoft Azure OMS Linux Agent deployed to your Cloud Foundry environment.
4. (Optional, might not be compatible with Microsoft Azure OMS Linux Agent) The Microsoft Azure OMS Linux Agent Bosh Release deployed to your Cloud Foundry environment.

This template can create a new Log Analytics workspace and deploy the following resources into the workspace, or deploy the following resources into an existing Log Analytics workspace.

• All OMS views defined here for Cloud Foundry metrics and logs
• Predefined alerts for all KPI events from Cloud Foundry environments
• Predefined saved searches for major Cloud Foundry metrics and logs

Installation

Follow these instructions to deploy the template:

1. If you want to use an existing Log Analytics workspace, note the name, location and resource group name of the workspace from Azure Portal.

2. Click "Deploy to Azure", this will send you to the Azure Portal with some default values for the template parameters.

   

3. Fill the parameters.

   1. Subscription: Select the subscription where your existing workspace is located, or where you want to create a new workspace

   2. Resource group: Select the resource group where your existing workspace is located, or enter a resource group name for your new workspace

   3. Location: Select the region of the resource group. If you're using an existing workspace, make sure you input correct location here

   4. OMS Workspace Name: Enter the name of your existing workspace. A new workspace with this name will be created if it does not exist

   5. OMS Workspace Region: Select the region where your existing workspace is located, or select a region for your new workspace

   6. Azure Monitor Pricing Model*: Select Azure Monitor pricing model your subscription has enabled. Note that April 2018 pricing model would be enabled automatically if you onboard Azure Monitor later than April 2, 2018

   7. OMS Workspace Sku: Select the pricing tier of the workspace. Note that PerGB2018 would be the only valid Sku if your subscription has enabled April 2018 pricing model. Thus, this parameter would be ignored if April 2018 is selected for Azure Monitor Pricing Model

   8. System Metrics Provider: Select provider for your system metrics, could be Microsoft Azure OMS Agent, BOSH Health Metrics Forwarder or both.

      *Please refer to document here for more detail about Azure Monitor April 2018 pricing model.

4. Once you have customized all the parameters, click Purchase.

Please refer to document here for instructions to install Microsoft Azure OMS Linux Agent.

Please refer to document here for instructions to install BOSH Health Metrics Forwarder.

Be aware that there might be compatibility issue if you choose to use both Microsoft Azure OMS Agent and BOSH Health Metrics Forwarder in a single one Cloud Foundry environment.

Customization and Upgrade

This template only deploys default resources with default settings, you might want to customize them to fit your needs.

If there are new features of this template you wish to use, you can redeploy the template by clicking the Deploy to Azure button on top to sync with all the latest features provided by our templates.

ALERT: Redeploy this template(azuredeploy.json) is equivalent to deploy all nested templates in folder /nested, please reefer to explanations of redeploying these nested templates below and make sure you understand it will cause customization loss.

Also notice that OMS Log Analytics workspace itself will not be modified during a redeployment. Thus your logs already in the workspace will not be lost and you don't have to change settings of neither Microsoft Azure Log Analytics Nozzle nor Microsoft Azure OMS Agent.

Customize and Upgrade Views

To Customize view, you can refer to instructions here.

To upgrade views, you can delete corresponding solutions from azure portal and then click here to redeploy nested view templates. Make sure you know this will overwrite your customization made to corresponding views.

You can also import new views manually. Views included in this template are located in repository Microsoft Azure Log Analytics Nozzle here. Please download views you wish to add and refer to document here on how to import them.

As you may noticed, you may export an existing view if you wish to preserve your customization. Please refer to document here on how to do that.

Customize and Upgrade Alerts

To upgrade alerts, you can click here to redeploy nested view templates. Make sure you know this will overwrite your customization made to alerts and corresponding saved searches EVEN you changed its original display name.

To add or customize alerts, please refer to document here for instruction.

Reference document for query language in OMS Log Analytics can be found here. You may also consult our template of alerts here.

Customize and Upgrade Saved Searches

To upgrade saved searches, you can click here to redeploy nested saved searches templates. Make sure you know this will also overwrite your customization made to saved searches EVEN you haved changed its display name.

To customize or create new saved searches, please login to Microsoft Azure portal, find and enter corresponding resource of Log Analytics Workspace. In page Saved searches under category General, you will find a complete list of saved searches of this workspace. Besides creating new saved searches, you can also execute, edit or delete existing searches here. You can also save your current search in Log Search page of OMS portal by clicking Save button.

Exploring the workspace

The template will deploy several views bundled in 3 solutions to your Log Analytics workspace along with alerts and saved searches.

Solution named AlertManagement is a solution from OMS marketplace provided by Microsoft to manage alerts in a more visible and more interactive way.

Once the template has been deployed successfully, you need to deploy the Microsoft Azure Log Analytics Nozzle to collect Cloud Foundry metrics and logs to the workspace. If the workspace is newly created, it might take several minutes for data to be injected after the nozzle is started.

We also recommend you to deploy Microsoft Azure OMS Linux Agent Bosh Release to collect VM data.

Views

You can view oms portal inside portal of Microsoft Azure. Navigate to the OMS Log Analytics workspace in your resource group. on the overview page, multiple views should be already imported.

You can also click OMS Portal button to visit legacy OMS portal.

Click on each view and more dashboards will be displayed.

Alerts

Go to Settings -> Alerts in OMS portal), there're 8 predefined alerts. You could edit and customize these alerts.

Log Search

Go to Log Search in your workspace (or Log Search in OMS portal), you could find log search page which is another key feature of OMS Log Analytics. You can search in logs and generate fancy graphs or charts with its query language.

Saved Searches

Go to Saved Searches in your workspace (or Log Search -> Favorites in OMS portal), you could find categorized search queries for major Cloud Foundry metrics and logs.

Monitor your environment Everywhere

OMS also provides mobile apps available on Windows (Mobile devices), Android and iOS, for users to view OMS views, receiving alerts and searching for logs from your mobile devices.

Simply download App from your app store and login with your account, you can have experience just the same as on your workplace everywhere.

Change Logs

Tags: Microsoft.Resources/deployments, Microsoft.OperationalInsights/workspaces/savedSearches, Microsoft.OperationalInsights/workspaces/savedSearches/schedules, Microsoft.OperationalInsights/workspaces/savedSearches/schedules/actions, Alert, Microsoft.OperationsManagement/solutions, Microsoft.OperationalInsights/workspaces