{
    "id": "ApacheTomcat",
    "title": "[Deprecated] Apache Tomcat",
    "publisher": "Apache",
    "descriptionMarkdown": "The Apache Tomcat solution provides the capability to ingest [Apache Tomcat](http://tomcat.apache.org/) events into Microsoft Sentinel. Refer to [Apache Tomcat documentation](http://tomcat.apache.org/tomcat-10.0-doc/logging.html) for more information.",
    "additionalRequirementBanner": "These queries are dependent on a parser based on a Kusto Function deployed as part of the solution.",
    "graphQueries": [
        {
            "metricName": "Total data received",
            "legend": "Tomcat_CL",
            "baseQuery": "TomcatEvent"
        }
    ],
    "sampleQueries": [
        {
            "description" : "Top 10 Clients (Source IP)",
            "query": "TomcatEvent\n | summarize count() by SrcIpAddr\n | top 10 by count_"
        }
    ],
    "dataTypes": [
        {
            "name": "Tomcat_CL",
            "lastDataReceivedQuery": "TomcatEvent\n            | summarize Time = max(TimeGenerated)\n            | where isnotempty(Time)"
        }
    ],
    "connectivityCriterias": [
        {
            "type": "IsConnectedQuery",
            "value": [
                "TomcatEvent\n            | summarize LastLogReceived = max(TimeGenerated)\n            | project IsConnected = LastLogReceived > ago(30d)"
            ]
        }
    ],
    "availability": {
        "status": 1,
        "isPreview": false
    },
    "permissions": {
        "resourceProvider": [
            {
                "provider": "Microsoft.OperationalInsights/workspaces",
                "permissionsDisplayText": "read and write permissions are required.",
                "providerDisplayName": "Workspace",
                "scope": "Workspace",
                "requiredPermissions": {
                    "write": true,
                    "read": true,
                    "delete": true
                }
            },
            {
                "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys",
                "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).",
                "providerDisplayName": "Keys",
                "scope": "Workspace",
                "requiredPermissions": {
                    "action": true
                }
            }
        ]
    },
    "instructionSteps": [
        {
            "title": "",
            "description": "**NOTE:** This data connector depends on a parser based on a Kusto Function to work as expected which is deployed as part of the solution. To view the function code in Log Analytics, open Log Analytics/Microsoft Sentinel Logs blade, click Functions and search for the alias TomcatEvent and load the function code or click [here](https://github.com/Azure/Azure-Sentinel/blob/master/Solutions/Tomcat/Parsers/TomcatEvent.txt).The function usually takes 10-15 minutes to activate after solution installation/update.",
            "instructions": [
            ]
        },
        {
            "title": "",
            "description": ">**NOTE:** This data connector has been developed using Apache Tomcat version 10.0.4",
            "instructions": [
            ]
        },
        {
            "title": "1. Install and onboard the agent for Linux or Windows",
            "description": "Install the agent on the Apache Tomcat Server where the logs are generated.\n\n> Logs from Apache Tomcat Server deployed on Linux or Windows servers are collected by **Linux** or **Windows** agents.",
            "instructions": [
                {
                "parameters": {
                "title": "Choose where to install the Linux agent:",
    "instructionSteps": [
            {
            "title": "Install agent on Azure Linux Virtual Machine",
            "description": "Select the machine to install the agent on and then click **Connect**.",
            "instructions": [
                {
                "parameters": {
                "linkType": "InstallAgentOnLinuxVirtualMachine"
                },
                "type": "InstallAgent"
                }
            ]
        },
            {
            "title": "Install agent on a non-Azure Linux Machine",
            "description": "Download the agent on the relevant machine and follow the instructions.",
            "instructions": [
                {
                "parameters": {
                "linkType": "InstallAgentOnLinuxNonAzure"
                },
                "type": "InstallAgent"
                }
            ]
        }
    ]
        },
            "type": "InstructionStepsGroup"
            }
        ]
            },
            {
                "instructions": [
                    {
                    "parameters": {
                    "title": "Choose where to install the Windows agent:",
        "instructionSteps": [
                {
                "title": "Install agent on Azure Windows Virtual Machine",
                "description": "Select the machine to install the agent on and then click **Connect**.",
                "instructions": [
                    {
                    "parameters": {
                    "linkType": "InstallAgentOnVirtualMachine"
                    },
                    "type": "InstallAgent"
                    }
                ]
            },
                {
                "title": "Install agent on a non-Azure Windows Machine",
                "description": "Download the agent on the relevant machine and follow the instructions.",
                "instructions": [
                    {
                    "parameters": {
                    "linkType": "InstallAgentOnNonAzure"
                    },
                    "type": "InstallAgent"
                    }
                ]
            }
        ]
            },
                "type": "InstructionStepsGroup"
                }
            ]
                },
    {
            "title": "2. Configure the logs to be collected",
            "description": "Configure the custom log directory to be collected" ,
            "instructions": [
                {
                    "parameters": {
                        "linkType": "OpenCustomLogsSettings"
                    },
                    "type": "InstallAgent"
                }
            ]
        },
    {
        "title": "",
        "description":"1. Select the link above to open your workspace advanced settings \n2. From the left pane, select **Data**, select **Custom Logs** and click **Add+**\n3. Click **Browse** to upload a sample of a Tomcat log file (e.g. access.log or error.log). Then, click **Next >**\n4. Select **New line** as the record delimiter and click **Next >**\n5. Select **Windows** or **Linux** and enter the path to Tomcat logs based on your configuration. Example: \n - **Linux** Directory:  '/var/log/tomcat/*.log' \n6. After entering the path, click the '+' symbol to apply, then click **Next >** \n7. Add **Tomcat_CL** as the custom log Name and click **Done**"
    }
]
}