Green-Software-Foundation · danuw · Apr 3, 2024 · Mar 27, 2024
@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/dotnet/sdk:6.0
+FROM mcr.microsoft.com/dotnet/sdk:8.0
 
 RUN apt-get update
 

@@ -8,7 +8,7 @@ env:
   # web app
   DOCKERFILE_PATH: "CarbonAware.WebApi/src/Dockerfile"
   HEALTH_ENDPOINT: "0.0.0.0:8080/health"
-  DLL_FILE_PATH: "./bin/Release/net6.0/CarbonAware.WebApi.dll"
+  DLL_FILE_PATH: "./bin/Release/net8.0/CarbonAware.WebApi.dll"
   DOTNET_SRC_DIR: "./src"
   # console app packages
   DOTNET_SOLUTION: "src/GSF.CarbonAware/src/GSF.CarbonAware.csproj"
@@ -40,9 +40,9 @@ jobs:
 
     - uses: actions/checkout@v2
     - name: Setup .NET
-      uses: actions/setup-dotnet@v1
+      uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: 6.0.x
+        dotnet-version: 8.0.x
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
@@ -86,14 +86,14 @@ jobs:
     needs: sln-build-and-test
     runs-on: ubuntu-latest
     container:
-      image: mcr.microsoft.com/dotnet/sdk:6.0
+      image: mcr.microsoft.com/dotnet/sdk:8.0
     steps:
       - uses: actions/checkout@v3
 
-      - name: Setup .NET Core SDK 6
-        uses: actions/setup-dotnet@v2
+      - name: Setup .NET Core SDK 8
+        uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
           include-prerelease: false
 
       - name: Install dependencies
@@ -123,6 +123,8 @@ jobs:
 
       - name: Generate Open API
         run: dotnet tool run swagger tofile --output ./wwwroot/api/v1/swagger.yaml --yaml ${{ env.DLL_FILE_PATH }} v1
+        env:
+          DOTNET_ROLL_FORWARD: LatestMajor
         working-directory: ./src/CarbonAware.WebApi/src 
 
       - name: Upload swagger artifact
@@ -144,7 +146,7 @@ jobs:
 
       - name: Docker Run Container
         run: |
-          docker run -d --name runnable-container -p 8080:80 ca-api
+          docker run -d --name runnable-container -p 8080:8080 ca-api
           docker container ls
 
       - name: Docker WGET Health Endpoint
@@ -164,10 +166,10 @@ jobs:
         uses: actions/checkout@v3
         with:
           ref: dev
-      - name: Setup .NET Core SDK 6
-        uses: actions/setup-dotnet@v2
+      - name: Setup .NET Core SDK 8
+        uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
           include-prerelease: false
       - name: Install dependencies
         run: dotnet restore
@@ -179,6 +181,8 @@ jobs:
         working-directory: ${{ env.DOTNET_SRC_DIR }}
       - name: Generate Open API
         run: dotnet tool run swagger tofile --output ./wwwroot/api/v1/swagger.yaml --yaml ${{ env.DLL_FILE_PATH }} v1
+        env:
+          DOTNET_ROLL_FORWARD: LatestMajor
       - name: Upload dev artifact
         uses: actions/upload-artifact@v1
         with:
@@ -199,10 +203,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Setup .NET Core SDK 6
-        uses: actions/setup-dotnet@v2
+      - name: Setup .NET Core SDK 8
+        uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
           include-prerelease: false
 
       - name: Create packages
@@ -244,4 +248,4 @@ jobs:
           command: config
           globs: |
             ./custom.markdownlint.jsonc
-            {"*[^.github]/**,*"}.md
+            {"*[^.github]/**,*"}.md
@@ -20,7 +20,7 @@ jobs:
       - name: Set up .NET Core
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
           include-prerelease: true
 
       - name: Build with dotnet

@@ -10,7 +10,7 @@
       "type": "coreclr",
       "request": "launch",
       "preLaunchTask": "buildCLI",
-      "program": "${workspaceFolder}/src/CarbonAware.CLI/src/bin/Debug/net6.0/caw.dll",
+      "program": "${workspaceFolder}/src/CarbonAware.CLI/src/bin/Debug/net8.0/caw.dll",
       "args": [
         "emissions",
         "--location", "${input:caw_location}"
@@ -27,7 +27,7 @@
       "type": "coreclr",
       "request": "launch",
       "preLaunchTask": "buildWebApi",
-      "program": "${workspaceFolder}/src/CarbonAware.WebApi/src/bin/Debug/net6.0/CarbonAware.WebApi.dll",
+      "program": "${workspaceFolder}/src/CarbonAware.WebApi/src/bin/Debug/net8.0/CarbonAware.WebApi.dll",
       "args": [],
       "cwd": "${workspaceFolder}/src/CarbonAware.WebApi/src/",
       "stopAtEntry": false,

@@ -18,7 +18,7 @@ generated libraries for your language of choice!
 
 Prerequisites:
 
-- .NET Core 6.0
+- .NET Core 8.0
 - Alternatively:
   - Docker
   - VSCode (it is recommended to work in a Dev Container)

@@ -456,10 +456,10 @@ CarbonAware.LocationSources.LocationSource: Warning: New key swedencentral_1 gen
 ## Error Handling
 
 The WebAPI leveraged the
-[.Net controller filter pipeline](https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/filters?view=aspnetcore-6.0)
+[.Net controller filter pipeline](https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/filters?view=aspnetcore-8.0)
 to ensure that all requests respond with a consistent JSON schema.
 
-![.Net controller filter pipeline image](https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/filters/_static/filter-pipeline-2.png?view=aspnetcore-6.0)
+![.Net controller filter pipeline image](https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/filters/_static/filter-pipeline-2.png?view=aspnetcore-8.0)
 
 Controllers are responsible for managing the "Success" responses. If an error
 occurs in the WebAPI code and an unhandled exception is thrown, the
@@ -470,7 +470,7 @@ caught and handled by the WebAPI code, the controller will continue to manage
 the response.
 
 The .Net framework will automatically respond to validation errors with a
-[ValidationProblemDetails](https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.validationproblemdetails?view=aspnetcore-6.0)
+[ValidationProblemDetails](https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.validationproblemdetails?view=aspnetcore-8.0)
 object. Using the Exception Filter class enables the WebAPI to consistently
 respond with the `ValidationProblemDetails` error schema in all error cases and
 take advantage of error handling automatically provided by the framework.
@@ -489,7 +489,7 @@ specification
     cd CarbonAware.WebApi/src
     dotnet tool restore
     dotnet build --configuration Release --no-restore
-    dotnet tool run swagger tofile --output ./wwwroot/api/v1/swagger.yaml --yaml bin/Release/net6.0/CarbonAware.WebApi.dll v1
+    dotnet tool run swagger tofile --output ./wwwroot/api/v1/swagger.yaml --yaml bin/Release/net8.0/CarbonAware.WebApi.dll v1
     ```
 1. The `CarbonAware.WebApi/src/wwwroot/api/v1/swagger.yaml` file contains the supported 
    OpenApi specification.

@@ -25,11 +25,11 @@ carbon_aware   v1        6293e2528bf2   About an hour ago   230MB
 ## Run WebApi Image
 
 1. Run the image using `docker run` with host port 8000 mapped to the WebApi
-   port 80 and configure environment variable settings for
+   port 8080 and configure environment variable settings for
    [WattTime](https://www.watttime.org) provider.
 
    ```sh
-   docker run --rm -p 8000:80 \
+   docker run --rm -p 8000:8080 \
    > -e DataSources__EmissionsDataSource="WattTime" \
    > -e DataSources__ForecastDataSource="WattTime" \
    > -e DataSources__Configurations__WattTime__Type="WattTime" \
@@ -40,7 +40,7 @@ carbon_aware   v1        6293e2528bf2   About an hour ago   230MB
    or the [ElectricityMaps](https://www.electricitymaps.com) provider
 
    ```sh
-   docker run --rm -p 8000:80 \
+   docker run --rm -p 8000:8080 \
    > -e DataSources__EmissionsDataSource="ElectricityMaps" \
    > -e DataSources__ForecastDataSource="ElectricityMaps" \
    > -e DataSources__Configurations__ElectricityMaps__Type="ElectricityMaps" \
@@ -52,7 +52,7 @@ carbon_aware   v1        6293e2528bf2   About an hour ago   230MB
    or the [ElectricityMapsFree](https://www.co2signal.com/) provider
 
    ```sh
-   docker run --rm -p 8000:80 \
+   docker run --rm -p 8000:8080 \
    > -e DataSources__EmissionsDataSource="ElectricityMapsFree" \
    > -e DataSources__Configurations__ElectricityMapsFree__Type="ElectricityMapsFree" \
    > -e DataSources__Configurations__ElectricityMapsFree__token="<YOUR_CO2SIGNAL_TOKEN>" \

@@ -19,9 +19,11 @@
     - [ElectricityMapsFree Configuration](#electricitymapsfree-configuration)
       - [API Token](#api-token)
       - [BaseUrl](#baseurl)
+  - [Cache](#cache)
   - [CarbonAwareVars](#carbonawarevars)
     - [Tracing and Monitoring Configuration](#tracing-and-monitoring-configuration)
     - [Verbosity](#verbosity)
+    - [Prometheus exporter](#prometheus-exporter-for-emissions-data)
     - [Web API Prefix](#web-api-prefix)
   - [LocationDataSourcesConfiguration](#locationdatasourcesconfiguration)
 - [Sample Configurations](#sample-configurations)
@@ -194,7 +196,7 @@ custom `EmissionsData` sets. The file should be located under the
 `<user's repo>/src/data/data-sources/` directory that is part of the repository.
 At build time, all the JSON files under `<user's repo>/src/data/data-sources/`
 are copied over the destination directory
-`<user's repo>/src/CarbonAware.WebApi/src/bin/[Debug|Publish]/net6.0/data-sources/json`
+`<user's repo>/src/CarbonAware.WebApi/src/bin/[Debug|Publish]/net8.0/data-sources/json`
 that is part of the `CarbonAware.WebApi` assembly. Also the file can be placed
 where the assembly `CarbonAware.WebApi.dll` is located under `data-sources/json`
 directory. For instance, if the application is installed under `/app`, copy the
@@ -327,6 +329,29 @@ The url to use when connecting to ElectricityMapsFree. Defaults to
 "https://api.co2signal.com/v1/" but can be overridden in the config if needed
 (such as to enable integration testing scenarios).
 
+## Cache
+
+Frequent access to data sources could cause problems such as performance trouble
+or exceed rate limit. To avoid them, you can configure data cache like this:
+
+```json
+{
+  "EmissionsDataCache": {
+    "Enabled": true,
+    "ExpirationMin": 30
+  }
+}
+```
+
+The behavior of current cache implementation:
+* Only emissions data are cached
+  * Forecast data are not stored
+* The result of the latest query to data sources is cached
+* Use cache rather than data sources if even one datum in cache match with the query
+  * Even though more data in data sources would be matched, they are not retrieved
+* Cached data are stored in memory
+  * They are cleard when the process of the SDK is down
+
 ## CarbonAwareVars
 
 This section contains the global settings for the SDK. The configuration looks
@@ -379,6 +404,32 @@ InstrumentationKey. For more details, please refer to
 AppInsights_InstrumentationKey="AppInsightsInstrumentationKey"
 ```
 
+### Prometheus exporter for emissions data
+
+> DISCLAIMER:  The `/metrics` Prometheus exporter is currently unsupported, and is used for internal GSF needs, and may change in the future.  It will retrieve _all_ emissions data and create heavy load on your data API's.  It is turned off by default.
+
+In the WebApi project, this application can exporse latest carbon emissions data as a prometheus exporter.
+
+```bash
+CarbonAwareVars__EnableCarbonExporter="true"
+```
+The scraping endpoint is `<ROOT_PATH>/metrics` like this:
+
+```bash
+http://localhost/metrics
+```
+
+By default, the exposed data are latest ones within last 24 hours. If you would like to change the period 
+in some reasones, you can configure the value like this:
+
+```json
+{
+  "CarbonExporter": {
+    "PeriodInHours": 48
+  }
+}
+```
+
 ### Verbosity
 
 You can configure the verbosity of the application error messages by setting the
@@ -427,7 +478,7 @@ By setting `LocationDataSourcesConfiguration` property with one or more location
 data sources, it is possible to load different `Location` data sets in order to
 have more than one location. For instance by setting two location regions, the
 property would be set as follow using
-[environment](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-6.0#naming-of-environment-variables)
+[environment](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-8.0#naming-of-environment-variables)
 variables:
 
 ```sh
@@ -458,7 +509,7 @@ curl "http://${IP_HOST}:${PORT}/emissions/bylocations/best?location=${REGION}&ti
 At build time, all the JSON files under
 `<user's repo>/src/data/location-sources` are copied over the destination
 directory
-`<user's repo>/src/CarbonAware.WebApi/src/bin/[Debug|Publish]/net6.0/location-sources/json`
+`<user's repo>/src/CarbonAware.WebApi/src/bin/[Debug|Publish]/net8.0/location-sources/json`
 that is part of the `CarbonAware.WebApi` assembly. Also the file can be placed
 where the assembly `CarbonAware.WebApi.dll` is located under
 `location-sources/json` directory. For instance, if the application is installed

@@ -63,7 +63,7 @@ project. When running in the dev container you will need:
 - [Remote Containers extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
 
 Alternatively you can run in your local environment using the
-[.NET Core 6.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0).
+[.NET Core 8.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0).
 
 ## SDK Configuration
 

@@ -1,6 +1,6 @@
 {
     "sdk": {
-        "version": "6.0.418",
+        "version": "8.0.201",
         "rollForward": "latestFeature"
     }
 }
@@ -39,7 +39,7 @@ spec:
           {{- end }}
           ports:
             - name: http
-              containerPort: 80
+              containerPort: 8080
               protocol: TCP
           volumeMounts:
             - name: appsettings

@@ -37,7 +37,7 @@ securityContext: {}
 
 service:
   type: ClusterIP
-  port: 80
+  port: 8080
 
 ingress:
   enabled: false

@@ -1,10 +1,10 @@
 # Find the Dockerfile at this URL
 # https://github.com/Azure/azure-functions-docker/blob/dev/host/4/bullseye/amd64/dotnet/dotnet-inproc/dotnet.Dockerfile
 
-FROM mcr.microsoft.com/azure-functions/dotnet:4.0 AS base
+FROM mcr.microsoft.com/azure-functions/dotnet-isolated:4-dotnet-isolated8.0 AS base
 WORKDIR /home/site/wwwroot
 
-FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build
+FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build
 COPY ["src/", "data/src/"]
 COPY ["scripts/", "data/scripts/"]
 COPY ["samples/", "data/samples/"]
@@ -21,3 +21,4 @@ RUN dotnet publish "samples/azure/azure-function/function.csproj" -c Release -o
 FROM base AS final
 WORKDIR /home/site/wwwroot
 COPY --from=publish /app/publish .
+ENV ASPNETCORE_CONTENTROOT=/home/site/wwwroot