Skip to content

Commit

Permalink
feat: add zipkin service
Browse files Browse the repository at this point in the history
update README.md
  • Loading branch information
tsirysndr committed Jul 21, 2024
1 parent 40dd06f commit 311b5e2
Show file tree
Hide file tree
Showing 11 changed files with 217 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/zipkin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: ci
on:
push:
branches:
- main
paths:
- zipkin/**
- .github/workflows/zipkin.yml
jobs:
zipkin-test:
strategy:
matrix:
os: [ubuntu-latest, macos-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v3
- name: Setup Fluent CI
uses: fluentci-io/setup-fluentci@v5
with:
wasm: true
plugin: rust
args: |
target_add wasm32-unknown-unknown
build --release --target wasm32-unknown-unknown
working-directory: zipkin
env:
GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Start zipkin
run: |
fluentci run target/wasm32-unknown-unknown/release/zipkin.wasm start
fluentci run target/wasm32-unknown-unknown/release/zipkin.wasm stop
working-directory: zipkin
env:
GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NIX_CONFIG: extra-access-tokens = github.com=${{ secrets.GH_ACCESS_TOKEN }}
10 changes: 10 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ default-members = [
"tidb",
"typesense",
"vault",
"zipkin",
]
members = [
"apache",
Expand Down Expand Up @@ -84,5 +85,6 @@ members = [
"tidb",
"typesense",
"vault",
"zipkin",
]
resolver = "2"
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ fluentci run --wasm postgres start
| [tidb](./tidb) | A distributed SQL database |
| [typesense](./typesense) | A fast, typo-tolerant search engine for building delightful search experiences |
| [vault](./vault) | A tool for managing secrets and protecting sensitive data |
| [zipkin](./zipkin) | A distributed tracing system |

## 🤝 Contributing

Expand Down
20 changes: 20 additions & 0 deletions zipkin/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[package]
authors = [
"Tsiry Sandratraina <tsiry.sndr@fluentci.io>",
]
description = "Zipkin plugin for FluentCI"
edition = "2021"
license = "MIT"
name = "zipkin"
version = "0.1.0"

[lib]
crate-type = [
"cdylib",
]

[dependencies]
anyhow = "1.0.82"
extism-pdk = "1.1.0"
fluentci-pdk = "0.2.1"
fluentci-types = "0.1.7"
19 changes: 19 additions & 0 deletions zipkin/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2024 Tsiry Sandratraina <tsiry.sndr@fluentci.io>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
54 changes: 54 additions & 0 deletions zipkin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Zipkin Plugin

[![fluentci pipeline](https://shield.fluentci.io/x/zipkin)](https://pkg.fluentci.io/zipkin)
[![ci](https://github.com/fluentci-io/services/actions/workflows/zipkin.yml/badge.svg)](https://github.com/fluentci-io/services/actions/workflows/zipkin.yml)

Zipkin service plugin for FluentCI.

## 🚀 Usage

Add the following command to your CI configuration file:

```bash
fluentci run --wasm redis start
```

## Functions

| Name | Description |
| ------ | -------------------------------------------------- |
| start | Start Zipkin server |
| stop | Stop Zipkin server |

## Code Usage

Add `fluentci-pdk` crate to your `Cargo.toml`:

```toml
[dependencies]
fluentci-pdk = "0.2.1"
```

Use the following code to call the plugin:

```rust
use fluentci_pdk::dag;

// ...

dag().call("https://pkg.fluentci.io/zipkin@v0.1.0?wasm=1", "start", vec![])?;
```

## 📚 Examples

Github Actions:

```yaml
- name: Setup Fluent CI CLI
uses: fluentci-io/setup-fluentci@v5
with:
wasm: true
plugin: zipkin
args: |
start
```
11 changes: 11 additions & 0 deletions zipkin/fluentci.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[package]
authors = [
"Tsiry Sandratraina <tsiry.sndr@fluentci.io>",
]
description = "Zipkin Plugin for FluentCI"
keywords = [
"zipkin",
]
license = "MIT"
name = "zipkin"
version = "0.1.0"
24 changes: 24 additions & 0 deletions zipkin/src/helpers.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
use anyhow::Error;
use fluentci_pdk::dag;

pub fn setup() -> Result<String, Error> {
dag()
.pipeline("setup")?
.with_exec(vec!["mkdir", "-p", ".fluentci/zipkin"])?
.stdout()?;

let stdout = dag()
.pkgx()?
.with_workdir(".fluentci/zipkin")?
.with_packages(vec![
"github.com/darthsim/overmind",
"github.com/tmux/tmux",
])?
.with_exec(vec!["[ -f zipkin.jar ] || pkgx curl -sSL https://zipkin.io/quickstart.sh | bash -s"])?
.with_exec(vec![
"grep -q zipkin: Procfile || echo -e 'zipkin: pkgx java -jar zipkin.jar \\n' >> Procfile",
])?
.stdout()?;

Ok(stdout)
}
40 changes: 40 additions & 0 deletions zipkin/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
use extism_pdk::*;
use fluentci_pdk::dag;

pub mod helpers;

#[plugin_fn]
pub fn start(_args: String) -> FnResult<String> {
helpers::setup()?;

let stdout = dag()
.pkgx()?
.with_workdir(".fluentci/zipkin")?
.with_exec(vec!["overmind", "--version"])?
.with_exec(vec!["type", "overmind"])?
.with_exec(vec![
"overmind start -f Procfile --daemonize || overmind restart zipkin",
])?
.wait_on(9411, None)?
.with_exec(vec!["overmind", "status"])?
.stdout()?;
Ok(stdout)
}

#[plugin_fn]
pub fn stop(args: String) -> FnResult<String> {
helpers::setup()?;

let args = if args.is_empty() {
"zipkin".to_string()
} else {
args
};

let stdout = dag()
.pkgx()?
.with_workdir(".fluentci/zipkin")?
.with_exec(vec!["overmind", "stop", &args])?
.stdout()?;
Ok(stdout)
}
1 change: 1 addition & 0 deletions zipkin/target

0 comments on commit 311b5e2

Please sign in to comment.