Мониторинг .NET приложений с помощью Proto Observability

apiVersion: apps/v1
kind: Deployment
#(...)
    spec:
      containers:
      - name: "<CONTAINER_NAME>"
        image: "<CONTAINER_IMAGE>/<TAG>"
        env:
          - name: POBP_SERVICE
            value: "<YOUR_SERVICE_NAME>"			
          - name: POBP_INSTRUMENTATION_TELEMETRY_ENABLED
            value: "0"
          - name: POBP_RUNTIME_METRICS_ENABLED
            value: "true"          
          - name: POBP_AGENT_HOST
            valueFrom:
              fieldRef:
                fieldPath: status.hostIP
          - name: NODE_NAME
            valueFrom:
              fieldRef:
                fieldPath: spec.nodeName
          - name: POD_NAMESPACE
            valueFrom:
              fieldRef:
                fieldPath: metadata.namespace
          - name: POD_NAME
            valueFrom:
              fieldRef:
                fieldPath: metadata.name
          - name: POBP_TAGS
            value: "pod_name:$(POD_NAME),node:$(NODE_NAME),kube_namespace:$(POD_NAMESPACE),kube_cluster_name:<your_cluster_name>"            
            

Import-Module WebAdministration

Add-WebConfigurationProperty `
  -pspath 'MACHINE/WEBROOT/APPHOST' `
  -filter "system.applicationHost/applicationPools/add[@name='SharePoint Web Services Root']/environmentVariables" `
  -name "." `
  -value @{name='POBP_SERVICE'; value='sharepoint-web-services'}

%windir%\system32\inetsrv\appcmd.exe set config -section:system.applicationHost/applicationPools ^
  /+"[name='SharePoint Web Services Root'].environmentVariables.[name='POBP_SERVICE',value='sharepoint-web-services']" ^
  /commit:apphost

$mapping = @{
    'SharePoint Web Services Root'    = 'sharepoint-web-services'
    'SecurityTokenServiceApplicationPool' = 'sharepoint-sts'
    'SharePoint Central Administration v4' = 'sharepoint-central-admin'
}

foreach ($pool in $mapping.Keys) {
    Add-WebConfigurationProperty `
      -pspath 'MACHINE/WEBROOT/APPHOST' `
      -filter "system.applicationHost/applicationPools/add[@name='$pool']/environmentVariables" `
      -name "." `
      -value @{name='POBP_SERVICE'; value=$mapping[$pool]}
}

Set-WebConfigurationProperty `
  -pspath 'MACHINE/WEBROOT/APPHOST' `
  -filter "system.applicationHost/applicationPools/add[@name='SharePoint Web Services Root']/environmentVariables/add[@name='POBP_SERVICE']" `
  -name "value" `
  -value "sharepoint-web-services-prod"

Remove-WebConfigurationProperty `
  -pspath 'MACHINE/WEBROOT/APPHOST' `
  -filter "system.applicationHost/applicationPools/add[@name='SharePoint Web Services Root']/environmentVariables" `
  -name "." `
  -AtElement @{name='POBP_SERVICE'}

POBP_TRACE_SERVICE_MAPPING=microsoft.servicebus.gateway:sharepoint-servicebus,microsoft.workflow.servicehost:sharepoint-workflow

$existing = (Get-ItemProperty -Path 'HKLM:\System\CurrentControlSet\Services\WAS' -Name 'Environment' -ErrorAction SilentlyContinue).Environment
$entry    = 'POBP_TRACE_SERVICE_MAPPING=microsoft.servicebus.gateway:sharepoint-servicebus,microsoft.workflow.servicehost:sharepoint-workflow'

$value = if ($existing) { @($existing) + $entry } else { @($entry) }

Set-ItemProperty -Path 'HKLM:\System\CurrentControlSet\Services\WAS' `
  -Name 'Environment' `
  -Value $value `
  -Type MultiString

Add-WebConfigurationProperty `
  -pspath 'MACHINE/WEBROOT/APPHOST' `
  -filter "system.applicationHost/applicationPools/add[@name='Microsoft.Workflow.ServiceHost']/environmentVariables" `
  -name "." `
  -value @{name='COR_ENABLE_PROFILING'; value='0'}

<system.applicationHost>
  <applicationPools>
    <add name="SharePoint Web Services Root" managedRuntimeVersion="" managedPipelineMode="Integrated">
      <environmentVariables>
        <add name="POBP_SERVICE" value="sharepoint-web-services" />
      </environmentVariables>
    </add>
    <add name="SecurityTokenServiceApplicationPool">
      <environmentVariables>
        <add name="POBP_SERVICE" value="sharepoint-sts" />
      </environmentVariables>
    </add>
  </applicationPools>
</system.applicationHost>

Restart-WebAppPool -Name "SharePoint Web Services Root"

net stop /y was
net start w3svc
# Также запустите все остальные службы, которые были остановлены при остановке WAS.

Get-CimInstance Win32_Process -Filter "Name='w3wp.exe'" |
  Select-Object ProcessId, CommandLine

2024-08-15 12:26:39.572 +03:00 [INF] PROTOOBP TRACER CONFIGURATION -
{"date":"2024-08-15T12:26:39.5615724+02:00","os_name":"Windows",
"os_version":"Microsoft Windows NT 6.2.9200.0","version":"1.17.1.0",
"platform":"x64","lang":".NET Framework","lang_version":"4.8+",
"env":null,"enabled":true,"service":"git-credential-manager",
"agent_url":"http://localhost:8126","debug":false,
"analytics_enabled":false,"sample_rate":null,"sampling_rules":null,
"tags":[],"log_injection_enabled":false,
"runtime_metrics_enabled":false,"disabled_integrations":[]}

POBP_RUNTIME_METRICS_ENABLED=true

FROM mcr.microsoft.com/dotnet/core/sdk:3.1 AS build
WORKDIR /app

COPY *.csproj ./
RUN dotnet restore

COPY . ./
RUN dotnet publish -c Release -f netcoreapp3.1 -o out

FROM mcr.microsoft.com/dotnet/core/runtime:3.1-alpine3.10
WORKDIR /app
COPY --from=build /app/out .

# Добавление curl 
RUN apk --no-cache update && apk add curl

# Подключение Protoobp
RUN mkdir -p /var/log/protoobp
RUN mkdir -p /opt/protoobp

RUN curl --header "PRIVATE-TOKEN:<YOUR_TOKEN>>" "https://git.proto.group/api/v4/projects/125/packages/generic/protoobp-dotnet-apm/2.56.0/protoobp-dotnet-apm-2.56.0-musl.tar.gz" \
  |  tar xzf - -C /opt/protoobp

ENV CORECLR_ENABLE_PROFILING=1
ENV CORECLR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
ENV CORECLR_PROFILER_PATH=/opt/protoobp/Protoobp.Trace.ClrProfiler.Native.so
ENV POBP_DOTNET_TRACER_HOME=/opt/protoobp
ENV POBP_INSTRUMENTATION_TELEMETRY_ENABLED=0

CMD ["dotnet", "ConsoleApp.dll"]

FROM mcr.microsoft.com/dotnet/core/sdk:3.1 AS build
WORKDIR /app

COPY *.csproj ./
RUN dotnet restore

COPY . ./
RUN dotnet publish -c Release -f netcoreapp3.1 -o out

FROM mcr.microsoft.com/dotnet/core/runtime:3.1
WORKDIR /app
COPY --from=build /app/out .

# Подключение Protoobp
RUN mkdir -p /var/log/protoobp
RUN mkdir -p /opt/protoobp
RUN curl -v --header "PRIVATE-TOKEN:<your_token>" "https://git.proto.group/api/v4/projects/125/packages/generic/protoobp-dotnet-apm/2.56.0/protoobp-dotnet-apm_2.56.0_amd64.deb" -o "protoobp-dotnet-apm_2.56.0_amd64.deb"
RUN dpkg -i ./protoobp-dotnet-apm_2.56.0_amd64.deb

ENV CORECLR_ENABLE_PROFILING=1
ENV CORECLR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
ENV CORECLR_PROFILER_PATH=/opt/protoobp/Protoobp.Trace.ClrProfiler.Native.so
ENV POBP_DOTNET_TRACER_HOME=/opt/protoobp
ENV POBP_INSTRUMENTATION_TELEMETRY_ENABLED=0

CMD ["dotnet", "ConsoleApp.dll"]

FROM mcr.microsoft.com/dotnet/runtime:5.0-alpine AS base
WORKDIR /app

FROM mcr.microsoft.com/dotnet/sdk:5.0 AS build
WORKDIR /src

# В nuget.config должна быть включена установка локально
COPY ["nuget.config", "./"]
# Файлы с двумя NuGet пакетам лежат в папке packages
COPY ["packages", "packages"]

COPY ["HttpListenerExample.csproj", "./"]
RUN dotnet restore "HttpListenerExample.csproj"
COPY . .
WORKDIR "/src"
RUN dotnet build "HttpListenerExample.csproj" -c Release -o /app/build

FROM build AS publish
RUN dotnet publish "HttpListenerExample.csproj" -c Release -o /app/publish

FROM base AS final
WORKDIR /app
COPY --from=publish /app/publish .

# Включение Protoobp трейсера для автоматической инструментации
# Приложение копируется в /app, поэтому файлы Protoobp будут в папке /app/protoobp
ENV CORECLR_ENABLE_PROFILING=1
ENV CORECLR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
ENV CORECLR_PROFILER_PATH=/app/protoobp/linux-musl-x64/Protoobp.Trace.ClrProfiler.Native.so
ENV POBP_DOTNET_TRACER_HOME=/app/protoobp
ENV POBP_INSTRUMENTATION_TELEMETRY_ENABLED=0

# Запуск скрипта createLogPath для создания директории с логами трейсера
RUN sh /app/protoob/createLogPath.sh

ENTRYPOINT ["dotnet", "HttpListenerExample.dll"]

FROM mcr.microsoft.com/dotnet/runtime:5.0 AS base
WORKDIR /app

FROM mcr.microsoft.com/dotnet/sdk:5.0 AS build
WORKDIR /src

# В nuget.config должна быть включена установка локально
COPY ["nuget.config", "./"]
# Файлы с двумя NuGet пакетам лежат в папке packages
COPY ["packages", "packages"]

COPY ["HttpListenerExample.csproj", "./"]
RUN dotnet restore "HttpListenerExample.csproj"
COPY . .
WORKDIR "/src"
RUN dotnet build "HttpListenerExample.csproj" -c Release -o /app/build

FROM build AS publish
RUN dotnet publish "HttpListenerExample.csproj" -c Release -o /app/publish

FROM base AS final
WORKDIR /app
COPY --from=publish /app/publish .

# Включение Protoobp трейсера для автоматической инструментации
# Приложение копируется в /app, поэтому файлы Protoobp будут в папке /app/protoobp
ENV CORECLR_ENABLE_PROFILING=1
ENV CORECLR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
ENV CORECLR_PROFILER_PATH=/app/protoobp/linux-x64/Protoobp.Trace.ClrProfiler.Native.so
ENV POBP_DOTNET_TRACER_HOME=/app/protoobp
ENV POBP_INSTRUMENTATION_TELEMETRY_ENABLED=0

# Запуск скрипта createLogPath для создания директории с логами трейсера
RUN /app/protoobp/createLogPath.sh

ENTRYPOINT ["dotnet", "HttpListenerExample.dll"]

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <targets>
        <!-- For JsonLayout, you can set includeMdlc=true to automatically extract all of the Protoobp properties (see: https://github.com/NLog/NLog/wiki/JsonLayout) -->
        <!--
            Additions to layout: none
        -->
        <target name="jsonFile-includeMdlc-true" xsi:type="File" fileName="log-NLog46-jsonFile-includeMdlc-true.log">
            <layout xsi:type="JsonLayout" includeMdlc="true"> <!-- includeMdlc property available in NLog 4.4.10+ -->
                <attribute name="time" layout="${longdate}" />
                <attribute name="level" layout="${level:upperCase=true}"/>
                <attribute name="message" layout="${message}" />
                <attribute name="exception" layout="${exception:format=ToString}" />
            </layout>
        </target>

        <!-- For JsonLayout, if includeMdlc=false or if not set, you must extract the Protoobp properties individually by adding <attribute> nodes (see: https://github.com/NLog/NLog/wiki/JsonLayout) -->
        <!--
            Additions to layout:
            - <attribute name="pobp.env" layout="${mdlc:item=pobp.env}"/>
            - <attribute name="pobp.service" layout="${mdlc:item=pobp.service}"/>
            - <attribute name="pobp.version" layout="${mdlc:item=pobp.version}"/>
            - <attribute name="pobp.trace_id" layout="${mdlc:item=pobp.trace_id}"/>
            - <attribute name="pobp.span_id" layout="${mdlc:item=pobp.span_id}"/>
        -->
        <target name="jsonFile-includeMdlc-false" xsi:type="File" fileName="log-NLog46-jsonFile-includeMdlc-false.log">
            <layout xsi:type="JsonLayout">
                <attribute name="time" layout="${longdate}" />
                <attribute name="level" layout="${level:upperCase=true}"/>
                <attribute name="message" layout="${message}" />
                <attribute name="exception" layout="${exception:format=ToString}" />

                <!-- Manual changes: start -->
                <attribute name="pobp.env" layout="${mdlc:item=pobp.env}"/>
                <attribute name="pobp.service" layout="${mdlc:item=pobp.service}"/>
                <attribute name="pobp.version" layout="${mdlc:item=pobp.version}"/>
                <attribute name="pobp.trace_id" layout="${mdlc:item=pobp.trace_id}"/>
                <attribute name="pobp.span_id" layout="${mdlc:item=pobp.span_id}"/>
                <!-- Manual changes: end -->
            </layout>
        </target>

        <!-- For a custom layout, you must extract the Protoobp properties individually by using the ${mdlc:item=String} syntax (see: https://github.com/NLog/NLog/wiki/MDLC-Layout-Renderer) -->
        <!--
            Additions to layout: {pobp.env=&quot;${mdlc:item=pobp.env}&quot;,pobp.service=&quot;${mdlc:item=pobp.service}&quot;,pobp.version=&quot;${mdlc:item=pobp.version}&quot;,pobp.trace_id=&quot;${mdlc:item=pobp.trace_id}&quot;,pobp.span_id=&quot;${mdlc:item=pobp.span_id}&quot;}
        -->
        <!--
            Parsing this log line with a custom Pipeline that adds Trace/Log correlation can be done with the following Processors:
            1. Grok Parser: Set the parsing rules to `log_parser %{date("yyyy-MM-pobp HH:mm:ss.SSSS"):time}\|%{word:level}\|%{notSpace:logger}\|\{%{data::keyvalue}}\|%{data:message}`
        -->
        <target name="textFile" xsi:type="File" fileName="log-NLog46-textFile.log"
                layout="${longdate}|${uppercase:${level}}|${logger}|{pobp.env=&quot;${mdlc:item=pobp.env}&quot;,pobp.service=&quot;${mdlc:item=pobp.service}&quot;,pobp.version=&quot;${mdlc:item=pobp.version}&quot;,pobp.trace_id=&quot;${mdlc:item=pobp.trace_id}&quot;,pobp.span_id=&quot;${mdlc:item=pobp.span_id}&quot;}|${message}" />
    </targets>

    <!-- rules to map from logger name to target -->
    <rules>
        <logger name="*" minlevel="Trace" writeTo="jsonFile-includeMdlc-true,jsonFile-includeMdlc-false,textFile" />
    </rules>
</nlog>

using Protoobp.Trace;
using NLog;

namespace NLog46Example
{
    class Program
    {
        private static readonly Logger Logger = LogManager.GetCurrentClassLogger();

        static void Main(string[] args)
        {
            using (MappedDiagnosticsLogicalContext.SetScoped("order-number", 1024))
            {
                Logger.Info("Message before a trace.");

                using (var scope = Tracer.Instance.StartActive("NLog46Example - Main()"))
                {
                    Logger.Info("Message during a trace.");
                }

                Logger.Info("Message after a trace.");
            }
        }
    }
}