Add simple Rust and Motoko examples for the Query Statistics feature (#857)

* Query stats sample program with timer-based rate support

* Fixes

* Various minor fixes

* Added instructions on how to use dfx to query the canister

* Minor cleanup

* Minor

* Official support from ic-cdk 0.12.1 now sufficient

* Update rust/query-stats/dfx.json

Co-authored-by: Severin Siffert <[email protected]>

* Update rust/query-stats/README.md

Co-authored-by: Severin Siffert <[email protected]>

* Minor README changes

* Added first bit of Motoko example

* chore: add CI jobs

* Make rust example smaller

* Update readme

* Rename example folder

* Update rust/query_stats/README.md

Co-authored-by: Jessie Mongeon <[email protected]>

---------

Co-authored-by: Stefan Kaestle <[email protected]>
Co-authored-by: Severin Siffert <[email protected]>
Co-authored-by: Jason <[email protected]>
Co-authored-by: Jason I <[email protected]>
Co-authored-by: Jessie Mongeon <[email protected]>

Author: 6 people

.github/workflows/motoko-query-stats.yaml

@@ -0,0 +1,43 @@
+name: motoko-query-stats
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    paths:
+      - motoko/query_stats/**
+      - .github/workflows/provision-darwin.sh
+      - .github/workflows/provision-linux.sh
+      - .github/workflows/motoko-query-stats.yaml
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  rust-basic-bitcoin-darwin:
+    runs-on: macos-12
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Provision Darwin
+        run: bash .github/workflows/provision-darwin.sh
+      - name: Motoko Query Stats Darwin
+        run: |
+          dfx start --background
+          pushd motoko/query_stats
+          dfx deploy query_stats
+          popd
+  rust-basic-bitcoin-linux:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Provision Linux
+        run: bash .github/workflows/provision-linux.sh
+      - name: Motoko Query Stats Linux
+        run: |
+          dfx start --background
+          pushd motoko/query_stats
+          dfx deploy query_stats
+          popd

.github/workflows/rust-query-stats.yaml

@@ -0,0 +1,43 @@
+name: rust-query-stats
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    paths:
+      - rust/query_stats/**
+      - .github/workflows/provision-darwin.sh
+      - .github/workflows/provision-linux.sh
+      - .github/workflows/rust-query-stats.yaml
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  rust-basic-bitcoin-darwin:
+    runs-on: macos-12
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Provision Darwin
+        run: bash .github/workflows/provision-darwin.sh
+      - name: Rust Query Stats Darwin
+        run: |
+          dfx start --background
+          pushd rust/query_stats
+          dfx deploy query_stats
+          popd
+  rust-basic-bitcoin-linux:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Provision Linux
+        run: bash .github/workflows/provision-linux.sh
+      - name: Rust Query Stats Linux
+        run: |
+          dfx start --background
+          pushd rust/query_stats
+          dfx deploy query_stats
+          popd

motoko/query_stats/README.md

@@ -0,0 +1,16 @@
+{
+  "canisters": {
+    "query_stats": {
+      "main": "src/query_stats_backend/main.mo",
+      "type": "motoko"
+    }
+  },
+  "defaults": {
+    "build": {
+      "args": "",
+      "packtool": ""
+    }
+  },
+  "output_env_file": ".env",
+  "version": 1
+}

motoko/query_stats/dfx.json

@@ -0,0 +1,28 @@
+import Nat "mo:base/Nat";
+import Time "mo:base/Time";
+import Principal "mo:base/Principal";
+
+actor QueryStats {
+
+  let IC = actor "aaaaa-aa" : actor {
+    canister_status : { canister_id : Principal } -> async {
+      query_stats : {
+        num_calls_total : Nat;
+        num_instructions_total : Nat;
+        request_payload_bytes_total : Nat;
+        response_payload_bytes_total : Nat;
+      };
+    };
+  };
+
+  public query func load() : async Int {
+    return Time.now();
+  };
+
+  public func get_current_query_stats_as_string() : async Text {
+    let stats = await IC.canister_status({
+      canister_id = Principal.fromActor(QueryStats);
+    });
+    return "Number of calls: " # Nat.toText(stats.query_stats.num_calls_total) # " - Number of instructions: " # Nat.toText(stats.query_stats.num_instructions_total) # " - Request payload bytes: " # Nat.toText(stats.query_stats.request_payload_bytes_total) # " - Response payload bytes: " # Nat.toText(stats.query_stats.response_payload_bytes_total);
+  };
+};