From f567458e92882b19ef10276a9cd16229ed49491a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 16:01:31 +0200 Subject: [PATCH 01/11] feat: add demo section --- demo/Dockerfile | 15 +++++++++++++++ demo/README.md | 5 +++++ demo/demo_script.rb | 34 ++++++++++++++++++++++++++++++++++ demo/run.sh | 16 ++++++++++++++++ 4 files changed, 70 insertions(+) create mode 100644 demo/Dockerfile create mode 100644 demo/README.md create mode 100644 demo/demo_script.rb create mode 100755 demo/run.sh diff --git a/demo/Dockerfile b/demo/Dockerfile new file mode 100644 index 0000000..19029fc --- /dev/null +++ b/demo/Dockerfile @@ -0,0 +1,15 @@ +FROM ruby:3.2-alpine + +WORKDIR /app + +# Install the logdash gem from RubyGems +RUN gem install logdash + +# Copy demo script +COPY demo/demo_script.rb /app/ + +# Set execute permissions +RUN chmod +x /app/demo_script.rb + +# Run the demo +CMD ["./demo_script.rb"] \ No newline at end of file diff --git a/demo/README.md b/demo/README.md new file mode 100644 index 0000000..db75d7e --- /dev/null +++ b/demo/README.md @@ -0,0 +1,5 @@ +# LogDash Ruby SDK Demo + +``` +LOGDASH_API_KEY=m2Obk2WaMe6kZXzK2lh8299x8N8V7dmj ./demo/run.sh +``` diff --git a/demo/demo_script.rb b/demo/demo_script.rb new file mode 100644 index 0000000..061f4a4 --- /dev/null +++ b/demo/demo_script.rb @@ -0,0 +1,34 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +require 'logdash' + +puts '=== LogDash SDK Demo ===' +puts + +# Example with API key (sends data to LogDash servers) +puts '--- With API Key Example ---' +logdash = Logdash.create(api_key: ENV['LOGDASH_API_KEY'] || 'YOUR_API_KEY_HERE', verbose: true) +logger = logdash[:logger] +metrics = logdash[:metrics] + +logger.info('This is an info log') +logger.error('This is an error log') +metrics.set('demo_users', 42) +metrics.mutate('demo_counter', 1) +puts + +# Example without API key (logs to console only) +puts '--- Without API Key Example (Local Console Only) ---' +local_logdash = Logdash.create(verbose: true) +local_logger = local_logdash[:logger] + +local_logger.info('Local info log') +local_logger.warn('Local warning log') +local_logger.debug('Local debug log') +puts + +puts 'Demo completed!' + +# Sleep for 1 second at the end +sleep 1 \ No newline at end of file diff --git a/demo/run.sh b/demo/run.sh new file mode 100755 index 0000000..dc44d9d --- /dev/null +++ b/demo/run.sh @@ -0,0 +1,16 @@ +#!/bin/sh +set -e + +cd "$(dirname "$0")/.." +echo "Building LogDash demo Docker image (using published gem)..." +docker build -t logdash-demo -f demo/Dockerfile . + +echo +echo "Running LogDash demo..." +echo +docker run --rm -it \ + -e LOGDASH_API_KEY="${LOGDASH_API_KEY:-YOUR_API_KEY_HERE}" \ + logdash-demo + +echo +echo "Demo completed successfully!" \ No newline at end of file From 00535cf3a652ad1b330d2da9c6b963b969eed64f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 16:04:10 +0200 Subject: [PATCH 02/11] feat(): wip --- demo/README.md | 2 +- demo/demo_script.rb | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/demo/README.md b/demo/README.md index db75d7e..cdfaae0 100644 --- a/demo/README.md +++ b/demo/README.md @@ -1,5 +1,5 @@ # LogDash Ruby SDK Demo ``` -LOGDASH_API_KEY=m2Obk2WaMe6kZXzK2lh8299x8N8V7dmj ./demo/run.sh +LOGDASH_API_KEY= ./demo/run.sh ``` diff --git a/demo/demo_script.rb b/demo/demo_script.rb index 061f4a4..2629526 100644 --- a/demo/demo_script.rb +++ b/demo/demo_script.rb @@ -8,7 +8,9 @@ # Example with API key (sends data to LogDash servers) puts '--- With API Key Example ---' -logdash = Logdash.create(api_key: ENV['LOGDASH_API_KEY'] || 'YOUR_API_KEY_HERE', verbose: true) +api_key = ENV['LOGDASH_API_KEY'] || 'YOUR_API_KEY_HERE' +puts "Using API Key: #{api_key}" +logdash = Logdash.create(api_key: api_key, verbose: true) logger = logdash[:logger] metrics = logdash[:metrics] From a7902acbb4ebd18470b31efc860eda35fd2520a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 16:05:16 +0200 Subject: [PATCH 03/11] feat(): wip --- demo/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/demo/README.md b/demo/README.md index cdfaae0..07a76f9 100644 --- a/demo/README.md +++ b/demo/README.md @@ -1,5 +1,7 @@ # LogDash Ruby SDK Demo +Use command below to test if the published SDK works + ``` LOGDASH_API_KEY= ./demo/run.sh ``` From e63738a8f46d1920477e01301eb1c80c43f0509b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 16:06:14 +0200 Subject: [PATCH 04/11] feat(): wip --- demo/demo_script.rb | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/demo/demo_script.rb b/demo/demo_script.rb index 2629526..6530554 100644 --- a/demo/demo_script.rb +++ b/demo/demo_script.rb @@ -20,16 +20,6 @@ metrics.mutate('demo_counter', 1) puts -# Example without API key (logs to console only) -puts '--- Without API Key Example (Local Console Only) ---' -local_logdash = Logdash.create(verbose: true) -local_logger = local_logdash[:logger] - -local_logger.info('Local info log') -local_logger.warn('Local warning log') -local_logger.debug('Local debug log') -puts - puts 'Demo completed!' # Sleep for 1 second at the end From 97a1e437542e118208b5da0534089e4d0cdb2417 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 16:08:51 +0200 Subject: [PATCH 05/11] feat(): wip --- demo/Dockerfile | 4 +++- demo/run.sh | 3 ++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/demo/Dockerfile b/demo/Dockerfile index 19029fc..b84eab7 100644 --- a/demo/Dockerfile +++ b/demo/Dockerfile @@ -2,7 +2,9 @@ FROM ruby:3.2-alpine WORKDIR /app -# Install the logdash gem from RubyGems +# Add --no-cache-dir to prevent gem caching +# Add a cache-busting argument to force re-installation when building +ARG CACHEBUST=1 RUN gem install logdash # Copy demo script diff --git a/demo/run.sh b/demo/run.sh index dc44d9d..daa2c73 100755 --- a/demo/run.sh +++ b/demo/run.sh @@ -3,7 +3,8 @@ set -e cd "$(dirname "$0")/.." echo "Building LogDash demo Docker image (using published gem)..." -docker build -t logdash-demo -f demo/Dockerfile . +# Force a complete rebuild with --no-cache +docker build --no-cache -t logdash-demo -f demo/Dockerfile . echo echo "Running LogDash demo..." From 958f8bd1fba3f7d97c75b8bbd0cd609287f51977 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 16:12:07 +0200 Subject: [PATCH 06/11] feat(): wip --- demo/Dockerfile | 6 ------ demo/demo_script.rb | 11 +++++------ demo/run.sh | 3 +-- 3 files changed, 6 insertions(+), 14 deletions(-) diff --git a/demo/Dockerfile b/demo/Dockerfile index b84eab7..5d6a554 100644 --- a/demo/Dockerfile +++ b/demo/Dockerfile @@ -2,16 +2,10 @@ FROM ruby:3.2-alpine WORKDIR /app -# Add --no-cache-dir to prevent gem caching -# Add a cache-busting argument to force re-installation when building -ARG CACHEBUST=1 RUN gem install logdash -# Copy demo script COPY demo/demo_script.rb /app/ -# Set execute permissions RUN chmod +x /app/demo_script.rb -# Run the demo CMD ["./demo_script.rb"] \ No newline at end of file diff --git a/demo/demo_script.rb b/demo/demo_script.rb index 6530554..5b0fb81 100644 --- a/demo/demo_script.rb +++ b/demo/demo_script.rb @@ -2,12 +2,15 @@ # frozen_string_literal: true require 'logdash' +require 'rubygems' puts '=== LogDash SDK Demo ===' + +# Get and display the logdash gem version +logdash_version = Gem.loaded_specs['logdash']&.version || 'unknown' +puts "Using logdash gem version: #{logdash_version}" puts -# Example with API key (sends data to LogDash servers) -puts '--- With API Key Example ---' api_key = ENV['LOGDASH_API_KEY'] || 'YOUR_API_KEY_HERE' puts "Using API Key: #{api_key}" logdash = Logdash.create(api_key: api_key, verbose: true) @@ -18,9 +21,5 @@ logger.error('This is an error log') metrics.set('demo_users', 42) metrics.mutate('demo_counter', 1) -puts - -puts 'Demo completed!' -# Sleep for 1 second at the end sleep 1 \ No newline at end of file diff --git a/demo/run.sh b/demo/run.sh index daa2c73..5e907c4 100755 --- a/demo/run.sh +++ b/demo/run.sh @@ -3,7 +3,6 @@ set -e cd "$(dirname "$0")/.." echo "Building LogDash demo Docker image (using published gem)..." -# Force a complete rebuild with --no-cache docker build --no-cache -t logdash-demo -f demo/Dockerfile . echo @@ -14,4 +13,4 @@ docker run --rm -it \ logdash-demo echo -echo "Demo completed successfully!" \ No newline at end of file +echo "Demo completed!" \ No newline at end of file From f498a969355c9bd07caf29881a79c1b80be8937d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 16:12:51 +0200 Subject: [PATCH 07/11] feat(): wip --- demo/demo_script.rb | 2 +- demo/run.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/demo/demo_script.rb b/demo/demo_script.rb index 5b0fb81..987c442 100644 --- a/demo/demo_script.rb +++ b/demo/demo_script.rb @@ -11,7 +11,7 @@ puts "Using logdash gem version: #{logdash_version}" puts -api_key = ENV['LOGDASH_API_KEY'] || 'YOUR_API_KEY_HERE' +api_key = ENV['LOGDASH_API_KEY'] puts "Using API Key: #{api_key}" logdash = Logdash.create(api_key: api_key, verbose: true) logger = logdash[:logger] diff --git a/demo/run.sh b/demo/run.sh index 5e907c4..ee5be67 100755 --- a/demo/run.sh +++ b/demo/run.sh @@ -9,7 +9,7 @@ echo echo "Running LogDash demo..." echo docker run --rm -it \ - -e LOGDASH_API_KEY="${LOGDASH_API_KEY:-YOUR_API_KEY_HERE}" \ + -e LOGDASH_API_KEY="${LOGDASH_API_KEY}" \ logdash-demo echo From b05eda1ff861a6639823e29adc5b07324ca9cb43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 16:26:10 +0200 Subject: [PATCH 08/11] feat(): wip --- demo/run.sh | 8 -------- 1 file changed, 8 deletions(-) diff --git a/demo/run.sh b/demo/run.sh index ee5be67..e6bb377 100755 --- a/demo/run.sh +++ b/demo/run.sh @@ -1,16 +1,8 @@ #!/bin/sh set -e -cd "$(dirname "$0")/.." -echo "Building LogDash demo Docker image (using published gem)..." docker build --no-cache -t logdash-demo -f demo/Dockerfile . -echo -echo "Running LogDash demo..." -echo docker run --rm -it \ -e LOGDASH_API_KEY="${LOGDASH_API_KEY}" \ logdash-demo - -echo -echo "Demo completed!" \ No newline at end of file From 6aac7f8ae20c4b75895ce11c8ecccb803e6d5b33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 17:27:42 +0200 Subject: [PATCH 09/11] feat(): wip --- .github/workflows/check-deployed-package.yml | 24 ++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/check-deployed-package.yml diff --git a/.github/workflows/check-deployed-package.yml b/.github/workflows/check-deployed-package.yml new file mode 100644 index 0000000..2a19f62 --- /dev/null +++ b/.github/workflows/check-deployed-package.yml @@ -0,0 +1,24 @@ +name: Check deployed package + +on: + push: + branches: + - main + - add-demo-section + +jobs: + run-demo: + name: Run LogDash Demo + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Make run script executable + run: chmod +x demo/run.sh + + - name: Run LogDash demo + env: + LOGDASH_API_KEY: ${{ secrets.LOGDASH_API_KEY }} + run: ./demo/run.sh From 1f5787f78248fcfd8c0875568b856c13ffda9744 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 17:29:12 +0200 Subject: [PATCH 10/11] feat(): wip --- .github/workflows/demo.yml | 23 +++++++++++++++++++++++ demo/run.sh | 13 +++++++++++-- 2 files changed, 34 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/demo.yml diff --git a/.github/workflows/demo.yml b/.github/workflows/demo.yml new file mode 100644 index 0000000..1b5b8ae --- /dev/null +++ b/.github/workflows/demo.yml @@ -0,0 +1,23 @@ +name: LogDash Demo + +on: + push: + branches: + - main + +jobs: + run-demo: + name: Run LogDash Demo + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Make run script executable + run: chmod +x demo/run.sh + + - name: Run LogDash demo + env: + LOGDASH_API_KEY: ${{ secrets.LOGDASH_API_KEY }} + run: ./demo/run.sh diff --git a/demo/run.sh b/demo/run.sh index e6bb377..bb5672e 100755 --- a/demo/run.sh +++ b/demo/run.sh @@ -1,8 +1,17 @@ #!/bin/sh set -e +echo "Building LogDash demo Docker image (using published gem)..." docker build --no-cache -t logdash-demo -f demo/Dockerfile . -docker run --rm -it \ - -e LOGDASH_API_KEY="${LOGDASH_API_KEY}" \ +echo +echo "Running LogDash demo..." +echo + +# Run in non-interactive mode which works everywhere +docker run --rm \ + -e LOGDASH_API_KEY="${LOGDASH_API_KEY:-YOUR_API_KEY_HERE}" \ logdash-demo + +echo +echo "Demo completed!" From d644cb70aab7d7c3144049992cc84270db21ea07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksander=20B=C5=82aszkiewicz?= Date: Thu, 22 May 2025 17:35:02 +0200 Subject: [PATCH 11/11] feat(): wip --- .github/workflows/demo.yml | 23 ----------------------- 1 file changed, 23 deletions(-) delete mode 100644 .github/workflows/demo.yml diff --git a/.github/workflows/demo.yml b/.github/workflows/demo.yml deleted file mode 100644 index 1b5b8ae..0000000 --- a/.github/workflows/demo.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: LogDash Demo - -on: - push: - branches: - - main - -jobs: - run-demo: - name: Run LogDash Demo - runs-on: ubuntu-latest - - steps: - - name: Checkout repository - uses: actions/checkout@v3 - - - name: Make run script executable - run: chmod +x demo/run.sh - - - name: Run LogDash demo - env: - LOGDASH_API_KEY: ${{ secrets.LOGDASH_API_KEY }} - run: ./demo/run.sh