ShadowTraffic

https://docs.shadowtraffic.io
Admin
ShadowTraffic is a product that helps you rapidly simulate production traffic to your...
Tokens:135,843
Snippets:1,123
Trust Score:6.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Output of sequentialString

Source: https://docs.shadowtraffic.io/functions/sequentialString

Demonstrates the output generated by the sequentialString function when configured with a starting point and an expression.

```json
[
    "sensor-1",
    "sensor-2",
    "sensor-3",
    "sensor-4",
    "sensor-5"
]

```

--------------------------------

### Linting Output Example

Source: https://docs.shadowtraffic.io/cheatsheet

This is an example of the output you might see when linting a configuration file, highlighting unrecognized keys.

```text
✔ Linting your configuration file /your/path/to/config.json...  
  
✱ Unrecognized generator keys:  
✘ Unrecognized key unexpected at path [ "generators", 0 ]  
  
✱ Unrecognized local configuration keys:  
✘ Unrecognized key maxEvents_typo at path [ "generators", 0, "localConfigs" ]  
  
✔ Complete.  

```

--------------------------------

### SQL Server Connection String Example

Source: https://docs.shadowtraffic.io/connections/sqlServer

Example of a SQL Server connection string. Ensure you replace placeholders with your actual server details.

```plaintext
Server=myServerAddress;
Database=myDataBase;
User Id=myUsername;
Password=myPassword;
Encrypt=True;
TrustServerCertificate=False;
Connection Timeout=30;
```

--------------------------------

### Set Starting Time in Global Configuration

Source: https://docs.shadowtraffic.io/generator-configuration/time

Use the `time` global configuration to set the initial wallclock time for the generator. This example demonstrates setting the `time` to a specific UNIX millisecond timestamp.

```json
{
    "generators": [
        {
            "topic": "sandbox",
            "value": {
                "now": {
                    "_gen": "formatDateTime",
                    "ms": {
                        "_gen": "now"
                    }
                }
            }
        }
    ],
    "globalConfigs": {
        "time": 1420099200000
    },
    "connections": {
        "kafka": {
            "kind": "kafka",
            "producerConfigs": {
                "bootstrap.servers": "localhost:9092",
                "key.serializer": "io.shadowtraffic.kafka.serdes.JsonSerializer",
                "value.serializer": "io.shadowtraffic.kafka.serdes.JsonSerializer"
            }
        }
    }
}

```

--------------------------------

### Example Output of someKeys

Source: https://docs.shadowtraffic.io/functions/someKeys

This snippet shows example outputs generated by the someKeys function, demonstrating various combinations of selected keys and their values.

```json
[
    {
        "lastName": "Hermann"
    },
    {
        "lastName": "Turner",
        "firstName": "Graig"
    },
    {
        "lastName": "Rolfson",
        "firstName": "Tiffani"
    },
    {
        "lastName": "O'Reilly",
        "firstName": "Jill"
    },
    {
        "lastName": "Abernathy",
        "firstName": "Devora"
    }
]
```

--------------------------------

### Histogram Configuration Example

Source: https://docs.shadowtraffic.io/functions/histogram

Example of how to configure the histogram function with specific bins and frequencies. This is useful for controlling lookup behavior.

```json
{
    "_gen": "histogram",
    "bins": [
        {
            "bin": 0.2,
            "frequency": 8
        },
        {
            "bin": 0.8,
            "frequency": 2
        }
    ]
}
```

--------------------------------

### Example Output with Variables

Source: https://docs.shadowtraffic.io/overview

This is an example of the output generated by the previous snippet, showing how the `sensorId` variable is consistently used in both the `key` and `value.url` fields.

```json
{
    "topic" : "sensorReadings",
    "key" : {
      "sensorId" : "6d95332c-fcc2-ff43-d48f-67053ecb5609"
    },
    "value" : {
      "reading" : 60.02,
      "timestamp" : 1716330583941,
      "url" : "http://mydomain.com/charts/6d95332c-fcc2-ff43-d48f-67053ecb5609"
    }
}

```

--------------------------------

### Docker Compose for ShadowTraffic

Source: https://docs.shadowtraffic.io/cheatsheet

Example Docker Compose configuration for running ShadowTraffic. This setup maps local files and configures entry points and commands.

```yaml
shadowtraffic:
  image: shadowtraffic/shadowtraffic:latest
  volumes:
    - .:/workspace
  entrypoint: ["java", "-Djava.security.manager=allow", "-Dfile.encoding=UTF-8", "-Dsun.stdout.encoding=UTF-8", "-Dsun.stderr.encoding=UTF-8", "-jar", "/home/shadowtraffic.jar"]
  command: ["--config", "/workspace/your-config.json"]
  env_file:
    - shadowtraffic/license.env

```

--------------------------------

### Databricks Connection and Generator Configuration

Source: https://docs.shadowtraffic.io/connections/databricks

Example of a full configuration including Databricks connection details and generator setup with table tags.

```json
{
    "generators": [
        {
            "table": "sandbox",
            "tags": {
                "key-1": "value-1",
                "key-2": "value-2"
            },
            "row": {
                "id": {
                    "_gen": "uuid"
                },
                "level": {
                    "_gen": "uniformDistribution",
                    "bounds": [
                        1,
                        10
                    ]
                },
                "active": {
                    "_gen": "boolean"
                }
            }
        }
    ],
    "connections": {
        "dbx": {
            "kind": "databricks",
            "connectionConfigs": {
                "host": "https://xxx.cloud.databricks.com",
                "token": "yyy",
                "warehouseId": "abc",
                "catalog": "def",
                "schema": "ghi"
            }
        }
    }
}

```

--------------------------------

### Set Starting Value for Sequential Integers

Source: https://docs.shadowtraffic.io/functions/sequentialInteger

Configures the sequence to begin at a specified number using the 'startingFrom' option. This allows for sequences that do not start at 0.

```json
{
    "_gen": "sequentialInteger",
    "startingFrom": 42
}
```

```json
[
    42,
    43,
    44,
    45,
    46
]
```

--------------------------------

### Lookup First Event Output Example

Source: https://docs.shadowtraffic.io/functions/lookup

Example output demonstrating how the 'first' lookup strategy causes all 'b' values to lock onto the first generated value of 'a'.

```json
[
    {
        "topic": "a",
        "key": null,
        "value": 110.93893101788113,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": 110.93893101788113,
        "headers": null
    },
    {
        "topic": "a",
        "key": null,
        "value": 89.14192828994,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": 110.93893101788113,
        "headers": null
    },
    {
        "topic": "a",
        "key": null,
        "value": 94.35940089737974,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": 110.93893101788113,
        "headers": null
    },
    {
        "topic": "a",
        "key": null,
        "value": 108.36103500448338,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": 110.93893101788113,
        "headers": null
    },
    {
        "topic": "a",
        "key": null,
        "value": 106.61900083698767,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": 110.93893101788113,
        "headers": null
    }
]

```

--------------------------------

### Example Merged Data

Source: https://docs.shadowtraffic.io/functions/merge

This snippet displays an example of the data structure that results from applying the merge function configuration.

```json
[
    {
        "firstName": "Marshall",
        "lastName": "Hintz",
        "score": 0
    },
    {
        "firstName": "Devon",
        "lastName": "Hegmann",
        "score": 4
    },
    {
        "firstName": "Marlena",
        "lastName": "D'Amore",
        "score": 7
    },
    {
        "firstName": "Luther",
        "lastName": "Cartwright",
        "score": 7
    },
    {
        "firstName": "Olevia",
        "lastName": "Huels",
        "score": 1
    }
]
```

--------------------------------

### Example Transformed Strings

Source: https://docs.shadowtraffic.io/functions/string

Illustrates the output of various string transformation configurations.

```json
[
    {
        "lower": "miss jim cartwright",
        "upper": "MR. DEVORA BARTELL",
        "capitalized": "Jill moen",
        "shortened": "Dev",
        "scrubbed": "SantiagoRolfson"
    },
    {
        "lower": "amos watsica ii",
        "upper": "DINORAH BOTSFORD",
        "capitalized": "Billy cummings dds",
        "shortened": "Sac",
        "scrubbed": "RenatoWilliamson"
    }
]
```

--------------------------------

### Example Git SHAs

Source: https://docs.shadowtraffic.io/functions/gitSha

This snippet shows an array of example Git SHA-256 strings generated by the gitSha function.

```json
[
    "79110c22dc58be2b66579f591d7573612fdf8c38f59a65618b62c88cc3969611",
    "109b6989227cc8fee62a17114d461a5c25b24de76190edf49de989583479047a",
    "4bdce8f9396a2ebadea15693626ef327cc8aa6c766395e29b2bbe54471ee03c0",
    "4036c35353a8e750b601caf3a2e8a9e78f36ae87d1750a9ecb4cb097f223d9a0",
    "6e22669c149a1dedad2c840f65c79b29c56ae66b91998555da5391db8c656715"
]

```

--------------------------------

### Example Output with Cardinality

Source: https://docs.shadowtraffic.io/function-modifiers/cardinality

This is an example of the output generated when using the cardinality settings defined previously. Observe how 'a' remains constant, 'b' shows repeated values after the third unique assignment, and 'c' continues to generate new values.

```json
[
    {
        "a": 8.8719,
        "b": 8.0521,
        "c": 7.8284
    },
    {
        "a": 8.8719,
        "b": 11.6722,
        "c": 9.6293
    },
    {
        "a": 8.8719,
        "b": 8.3685,
        "c": 4.7994
    },
    {
        "a": 8.8719,
        "b": 8.3685,
        "c": 11.8981
    },
    {
        "a": 8.8719,
        "b": 11.6722,
        "c": 11.9023
    },
    {
        "a": 8.8719,
        "b": 8.3685,
        "c": 10.1658
    },
    {
        "a": 8.8719,
        "b": 11.6722,
        "c": 8.6842
    },
    {
        "a": 8.8719,
        "b": 8.3685,
        "c": 10.6292
    },
    {
        "a": 8.8719,
        "b": 8.3685,
        "c": 12.6035
    },
    {
        "a": 8.8719,
        "b": 11.6722,
        "c": 9.083
    }
]
```

--------------------------------

### Example Schedule with Loop Enabled

Source: https://docs.shadowtraffic.io/schedule/loop

This JSON configuration defines a schedule with two stages and enables looping. The schedule will repeat indefinitely.

```json
{
    "generators": [
        {
            "name": "a",
            "topic": "generatorA",
            "value": {
                "_gen": "oneOf",
                "choices": [
                    1,
                    2,
                    3
                ]
            },
            "localConfigs": {
                "maxEvents": 3
            }
        },
        {
            "name": "b",
            "topic": "generatorB",
            "value": {
                "_gen": "boolean"
            },
            "localConfigs": {
                "maxEvents": 2
            }
        }
    ],
    "schedule": {
        "loop": true,
        "stages": [
            {
                "generators": [
                    "a"
                ]
            },
            {
                "generators": [
                    "b"
            }
        ]
    },
    "connections": {
        "kafka": {
            "kind": "kafka",
            "producerConfigs": {
                "bootstrap.servers": "localhost:9092",
                "key.serializer": "io.shadowtraffic.kafka.serdes.JsonSerializer",
                "value.serializer": "io.shadowtraffic.kafka.serdes.JsonSerializer"
            }
        }
    }
}

```

--------------------------------

### Constant Function Output Example

Source: https://docs.shadowtraffic.io/functions/constant

This example illustrates the output of the constant function when configured to produce a repeated value. It shows an array where each element is the constant value 'foo'.

```json
[
    "foo",
    "foo",
    "foo",
    "foo",
    "foo"
]
```

--------------------------------

### Divide Numbers Example

Source: https://docs.shadowtraffic.io/functions/divide

Demonstrates how to use the 'divide' function to divide a list of numbers. The function takes an array of arguments for division.

```json
{
    "_gen": "divide",
    "args": [
        80,
        2,
        4
    ]
}

```

```json
[
    10
]

```

--------------------------------

### Example Output of Varied-Size Bytes

Source: https://docs.shadowtraffic.io/functions/bytes

This shows an example of the output when generating byte arrays with varied sizes. The lengths of the base64 encoded strings will differ.

```json
[
    "vWdD59yXhXOZjmheiFyzYQ==",
    "EQCydlRXGMMPQGzI46GI",
    "Vd+9b4O4lnDW2fm/Utg97twL9mIFg1zMFq1oLYxHiib0UCeYSQ==",
    "8n9y0380e12ZeRYs+pWd",
    "l+lTwAJsxKResy+Sgp6NFO6CfJTtyTUX732kwM4pcsybBgsItkYIUfOjoFuxAvcy"
]
```

--------------------------------

### Example Output of Fixed-Size Bytes

Source: https://docs.shadowtraffic.io/functions/bytes

This shows an example of the output when generating fixed-size byte arrays. The output is a list of base64 encoded strings.

```json
[
    "5DwIT0u7K/GDne5GbYUstb5qYaqaDGEX",
    "vWdD59yXhXOZjmheiFyzYfhsl0Ygvr+w",
    "EQCydlRXGMMPQGzI46GI//EQWetvvOYm",
    "Vd+9b4O4lnDW2fm/Utg97twL9mIFg1zM",
    "Fq1oLYxHiib0UCeYSVmbVt1TszUaVytA"
]
```

--------------------------------

### Basic KurrentDB Connection (Python)

Source: https://docs.shadowtraffic.io/connections/kurrentdb

Establishes a basic connection to KurrentDB using Python. Ensure you have the KurrentDB client library installed.

```python
from kurrentdb import KurrentDB

db = KurrentDB(host='localhost', port=5432, user='admin', password='password')
print("Connected to KurrentDB")
```

--------------------------------

### Kafka Lookup Output Example

Source: https://docs.shadowtraffic.io/functions/lookup

Example output from a Kafka lookup scenario, showing generated events from topics 'a' and 'b'. The 'value' in topic 'b' is populated by looking up the 'id' from topic 'a'.

```json
[
    {
        "topic": "a",
        "key": {
            "id": "Joshua"
        },
        "value": null,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": "Joshua",
        "headers": null
    },
    {
        "topic": "a",
        "key": {
            "id": "Elvina"
        },
        "value": null,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": "Elvina",
        "headers": null
    },
    {
        "topic": "a",
        "key": {
            "id": "Graig"
        },
        "value": null,
        "headers": null
    }
]
```

--------------------------------

### Postgres Lookup Output Example

Source: https://docs.shadowtraffic.io/functions/lookup

Example output from a Postgres lookup scenario. The 'row' in table 'b' is populated by looking up the 'id' from table 'a', demonstrating cross-table data retrieval.

```json
[
    {
        "table": "a",
        "row": {
            "id": "Joshua"
        },
        "op": null,
        "where": null
    },
    {
        "table": "b",
        "row": {
            "id": "Joshua"
        },
        "op": null,
        "where": null
    },
    {
        "table": "a",
        "row": {
            "id": "Elvina"
        },
        "op": null,
        "where": null
    },
    {
        "table": "b",
        "row": {
            "id": "Elvina"
        },
        "op": null,
        "where": null
    },
    {
        "table": "a",
        "row": {
            "id": "Graig"
        },
        "op": null,
        "where": null
    }
]
```

--------------------------------

### Linear Easing Example

Source: https://docs.shadowtraffic.io/functions/easing

Demonstrates linear easing over a duration. Use when a constant rate of change is required.

```json
{
    "_gen": "easing",
    "direction": "easeIn",
    "degree": "linear",
    "from": 5,
    "to": 125,
    "duration": 8000
}
```

```json
[
    5,
    5.015001875234404,
    5.030003750468809,
    5.0450056257032125,
    5.060007500937617,
    5.075009376172021,
    5.090011251406426,
    5.10501312664083,
    5.120015001875235,
    5.1350168771096385
]
```

--------------------------------

### Example Sensor Readings Output

Source: https://docs.shadowtraffic.io/overview

Illustrates the expected output format for sensor readings after applying the 'decimals' modifier.

```json
[
    {
        "sensorId" : "5a5be9a6-6245-e6c3-9d9d-a67a0121607e"
        "reading" : 65.0,
        "timestamp" : 1716393799097
    },
    {
        "sensorId" : "1ef26028-4e5d-e57f-171a-ae256a1c498f"
        "reading" : 69.44,
        "timestamp" : 1716393799106
    },
    {
        "sensorId" : "5a6798a9-3792-6b1f-b888-74c87170d00a"
        "reading" : 56.41,
        "timestamp" : 1716393799107
    }
]
```

--------------------------------

### Java KurrentDB Connection

Source: https://docs.shadowtraffic.io/connections/kurrentdb

Illustrates connecting to KurrentDB with Java. This example assumes you have the KurrentDB JDBC driver available.

```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

public class KurrentDBConnect {
    public static void main(String[] args) {
        String url = "jdbc:kurrentdb://localhost:5432/mydatabase";
        String user = "admin";
        String password = "password";

        try (Connection conn = DriverManager.getConnection(url, user, password)) {
            System.out.println("Connected to KurrentDB");
        } catch (SQLException e) {
            System.err.println("Connection failed: " + e.getMessage());
        }
    }
}
```

--------------------------------

### Connect to MotherDuck with Python

Source: https://docs.shadowtraffic.io/connections/motherduck

Use this Python code to establish a connection to MotherDuck. Ensure you have the 'duckdb' library installed.

```python
import duckdb

con = duckdb.connect(database=':memory:', read_only=False)
con.execute("INSTALL motherduck;")
con.execute("LOAD motherduck;")
con.execute("SET motherduck_token='YOUR_MOTHERDUCK_TOKEN';")
con.execute("SELECT * FROM motherduck.list_databases();")
```

--------------------------------

### License File Configuration

Source: https://docs.shadowtraffic.io/quickstart

Create a license.env file with your license variables. Obtain a license if you don't have one.

```env
LICENSE_ID=xxx
LICENSE_EMAIL=xxx
LICENSE_ORGANIZATION=xxx
LICENSE_EDITION=xxx
LICENSE_EXPIRATION=xxx
LICENSE_SIGNATURE=xx

```

--------------------------------

### Connecting to SQL Server with C#

Source: https://docs.shadowtraffic.io/connections/sqlServer

Demonstrates how to establish a connection to a SQL Server database using C# and the System.Data.SqlClient namespace. This is useful for backend applications requiring database access.

```csharp
using System;
using System.Data.SqlClient;

public class Example
{
    public static void Main(string[] args)
    {
        string connectionString = "Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;";

        using (SqlConnection connection = new SqlConnection(connectionString))
        {
            try
            {
                connection.Open();
                Console.WriteLine("Connection successful!");
                // Perform database operations here
            }
            catch (SqlException ex)
            {
                Console.WriteLine($"Error connecting to SQL Server: {ex.Message}");
            }
        }
    }
}
```

--------------------------------

### Single Sensor State Machine Example

Source: https://docs.shadowtraffic.io/overview

This snippet defines a state machine for a single sensor. It generates readings with a drift effect, starting from a base value and adding random fluctuations. Use this to model individual sensor lifecycles.

```json
{
    "generators": [
        {
            "topic": "sensorReadings",
            "key": {
                "sensorId": "2d9549cc-ac0f-b899-0b8b-cca3fc0691d3"
            },
            "value": {
                "timestamp": { "_gen": "now" }
            },
            "stateMachine": {
                "_gen": "stateMachine",
                "initial": "start",
                "transitions": {
                    "start": "update",
                    "update": "update"
                },
                "states": {
                    "start": {
                        "value": {
                            "reading": {"_gen": "normalDistribution", "mean": 60, "sd": 5, "decimals": 2 }
                        }
                    },
                    "update": {
                        "value": {
                            "reading": {
                                "_gen": "add",
                                "args": [
                                    { "_gen": "uniformDistribution", "bounds": [-1, 1] },
                                    { "_gen": "previousEvent", "path": [ "value", "reading" ] }
                                ],
                                "decimals": 2
                            }
                        }
                    }
                }
            },
            "localConfigs": { "throttleMs": 1000 }
        }
    ],
    "connections": {
        "dev-kafka": { ... }
    }
}

```

--------------------------------

### Start ShadowTraffic Container

Source: https://docs.shadowtraffic.io/cheatsheet

Run a ShadowTraffic container with specified environment variables and configuration file. Ensure 'license.env' contains your license details and 'your-config.json' is your ShadowTraffic configuration.

```bash
docker run --env-file license.env \
           -v $(pwd)/your-config.json:/home/config.json \
           shadowtraffic/shadowtraffic:latest \
           --config /home/config.json \
           --watch --sample 10 --stdout  

```

--------------------------------

### Postgres Timestamp Example Output

Source: https://docs.shadowtraffic.io/function-modifiers/serialize

Example output of a value serialized to a Postgres Timestamp format.

```json
[
    {
        "timestamp": "2024-04-25T20:28:47.262Z"
    },
    {
        "timestamp": "2024-04-25T20:28:47.263Z"
    },
    {
        "timestamp": "2024-04-25T20:28:47.264Z"
    },
    {
        "timestamp": "2024-04-25T20:28:47.265Z"
    },
    {
        "timestamp": "2024-04-25T20:28:47.266Z"
    }
]
```

--------------------------------

### ShadowTraffic Configuration

Source: https://docs.shadowtraffic.io/quickstart

Create a hello-world.json file with the ShadowTraffic configuration, including topic and connection details.

```json
{
  "generators": [
    {
      "topic": "testTopic",
      "value": {
        "emoji": {
          "_gen": "oneOf",
          "choices": [
            "👍", "🔥", "❤️"
          ]
        }
      }
    }
  ],
  "connections": {
    "localKafka": {
      "kind": "kafka",
      "producerConfigs": {
        "bootstrap.servers": "localhost:9092",
        "key.serializer" : "io.shadowtraffic.kafka.serdes.JsonSerializer",
        "value.serializer" : "io.shadowtraffic.kafka.serdes.JsonSerializer"
      }
    }
  }
}

```

--------------------------------

### Avro Fixed Example Output

Source: https://docs.shadowtraffic.io/function-modifiers/serialize

Example output of a value serialized to an Avro Fixed format.

```json
[
    "ä<OK»+ñƒ îFm…,µ",
    "¾jaªš\fa\u0017½gCçÜ—…s",
    "™Žh^ˆ\³aøl—F ¾¿°",
    "\u0011\u0000²vTW\u0018Ã\u000f@lÈã¡ˆÿ",
    "ñ\u0010Yëo¼æ&Uß½oƒ¸–p"
]
```

--------------------------------

### Connection Pool Example (Python)

Source: https://docs.shadowtraffic.io/connections/kurrentdb

Demonstrates creating a connection pool for efficient KurrentDB access. This is recommended for applications with frequent database interactions.

```python
from kurrentdb import KurrentDB
from kurrentdb.pool import ConnectionPool

pool = ConnectionPool(
    host='localhost',
    port=5432,
    user='admin',
    password='password',
    min_connections=5,
    max_connections=20
)

with pool.connection() as db:
    print("Acquired connection from pool")
    # Perform database operations here
print("Connection returned to pool")
```

--------------------------------

### Avro Decimal Example Output

Source: https://docs.shadowtraffic.io/function-modifiers/serialize

Example output of a value serialized to an Avro Decimal format.

```json
[
    "\u0000§q",
    "\u0000¯ÿ",
    "\u0000Ø",
    "\u0000Ä8",
    "\u0000®\u001b"
]
```

--------------------------------

### Docker Mount for Aiven SSL Files

Source: https://docs.shadowtraffic.io/connections/kafka

Example Docker run command to mount SSL keystore and truststore files into the container for Aiven connections.

```bash
docker run ... -v $(pwd)/ssl:/home/ssl

```

--------------------------------

### Generated ULID Examples

Source: https://docs.shadowtraffic.io/functions/ulid

This array shows example ULID strings generated by the function. ULIDs are time-sortable and unique.

```json
[
    "01HWBF4H8YWGY0GKTBQCNZ30WX",
    "01HWBF4H8ZDP2JSDDYD9GTN6GC",
    "01HWBF4H90QNKM7SYWJY2Q76CE",
    "01HWBF4H91H1EB6RFRDJBMC85Y",
    "01HWBF4H92240B4XJMAWCC63T0"
]

```

--------------------------------

### Basic Kafka Connection Configuration

Source: https://docs.shadowtraffic.io/connections/kafka

Sets up a basic Kafka connection with default serializers. Ensure bootstrap servers and serializers are correctly defined.

```json
{
    "connections": {
        "dev-kafka": {
            "kind": "kafka",
            "producerConfigs": {
                "bootstrap.servers": "localhost:9092",
                "key.serializer": "io.shadowtraffic.kafka.serdes.JsonSerializer",
                "value.serializer": "io.shadowtraffic.kafka.serdes.JsonSerializer"
            }
        }
    }
}

```

--------------------------------

### Generator JSON Schema Example

Source: https://docs.shadowtraffic.io/connections/s3

This is an example of the Generator JSON schema, defining properties for data generation and storage.

```json
{
    "type": "object",
    "properties": {
        "_gen": {
            "type": "string"
        }
    },
    "required": [
        "_gen"
    ]
}
```

--------------------------------

### Configure Basic SQL Server Connection with Batching

Source: https://docs.shadowtraffic.io/connections/sqlServer

Sets up a SQL Server connection with optional batch configuration. Transactions are written based on time or row count thresholds.

```json
{
    "connections": {
        "sql": {
            "kind": "sqlServer",
            "connectionConfigs": {
                "host": "localhost",
                "port": 1433,
                "username": "sql-server-user",
                "password": "sql-server-pw",
                "db": "mydb"
            },
            "batchConfigs": {
                "lingerMs": 500,
                "batchRows": 5000
            }
        }
    }
}

```

--------------------------------

### Connect to MotherDuck with SQL

Source: https://docs.shadowtraffic.io/connections/motherduck

This SQL snippet demonstrates how to set up and use MotherDuck within a SQL environment. Replace 'YOUR_MOTHERDUCK_TOKEN' with your actual token.

```sql
INSTALL motherduck;
LOAD motherduck;
SET motherduck_token='YOUR_MOTHERDUCK_TOKEN';
SELECT * FROM motherduck.list_databases();
```

--------------------------------

### Launch ShadowTraffic Studio with Docker

Source: https://docs.shadowtraffic.io/studio

This command launches the ShadowTraffic container with the studio enabled, forwarding the studio port and mounting a configuration file. Use this to start the studio for visual data inspection.

```bash
docker run --env-file license.env \
           -p 9876:8080 \
           -v $(pwd)/your-config.json:/home/config.json \
           shadowtraffic/shadowtraffic:latest \
           --config /home/config.json \
           --with-studio \
           --watch \
           --sample 10  

```

--------------------------------

### Define Generators and Stages

Source: https://docs.shadowtraffic.io/schedule/stages

This example demonstrates how to define multiple generators with unique names and then schedule them to run sequentially in distinct stages. Each stage executes its generators only after the previous stage's generators have completed.

```json
{
    "generators": [
        {
            "name": "a",
            "topic": "generatorA",
            "value": {
                "_gen": "oneOf",
                "choices": [
                    1,
                    2,
                    3
                ]
            },
            "localConfigs": {
                "maxEvents": 3
            }
        },
        {
            "name": "b",
            "topic": "generatorB",
            "value": {
                "_gen": "boolean"
            },
            "localConfigs": {
                "maxEvents": 2
            }
        }
    ],
    "schedule": {
        "stages": [
            {
                "generators": [
                    "a"
                ]
            },
            {
                "generators": [
                    "b"
                ]
            }
        ]
    },
    "connections": {
        "kafka": {
            "kind": "kafka",
            "producerConfigs": {
                "bootstrap.servers": "localhost:9092",
                "key.serializer": "io.shadowtraffic.kafka.serdes.JsonSerializer",
                "value.serializer": "io.shadowtraffic.kafka.serdes.JsonSerializer"
            }
        }
    }
}
```

```json
[
    1,
    2,
    3,
    true,
    true
]
```

--------------------------------

### Example Sensor Reading Event

Source: https://docs.shadowtraffic.io/overview

An example of a sensor reading event generated by ShadowTraffic, including a unique sensor ID and reading data.

```json
{
    "topic" : "sensorReadings",
    "key" : {
      "sensorId" : "a2c57eea-0589-70f8-b557-25e7ebb399c4"
    },
    "value" : {
      "reading" : 57.91,
      "timestamp" : 1716330021188
    }
}

```

--------------------------------

### Example Interpolated Strings

Source: https://docs.shadowtraffic.io/functions/interpolate

This array shows example output strings after token interpolation. Each string represents a SQL query with a unique UUID inserted.

```json
[
    "SELECT * FROM table1 WHERE column1='aa616abe-1761-0c9a-e743-67bd738597dc';",
    "SELECT * FROM table1 WHERE column1='5e688e99-61b3-5c88-4697-6cf7b0bfbe20';",
    "SELECT * FROM table1 WHERE column1='76b20010-c318-5754-c86c-400eff88a1e3';",
    "SELECT * FROM table1 WHERE column1='eb5910f1-26e6-bc6f-6fbd-df557096b883';",
    "SELECT * FROM table1 WHERE column1='bff9d9d5-ee3d-d852-62f6-0bdbcc5c8305';"
]

```

--------------------------------

### Example Data for Multiple Lookups

Source: https://docs.shadowtraffic.io/functions/lookup

Provides sample data illustrating the output of a multiple lookup scenario. This data shows how values are populated based on the lookup variable.

```json
[
  {
    "topic": "a",
    "key": {
      "name": "Tiffani Schaden",
      "magicNumber": 68
    },
    "value": null,
    "headers": null
  },
  {
    "topic": "b",
    "key": null,
    "value": {
      "lookedUpName": "Tiffani Schaden",
      "lookedUpNumber": 68
    },
    "headers": null
  },
  {
    "topic": "a",
    "key": {
      "name": "Mr. Devora Bartell",
      "magicNumber": 10
    },
    "value": null,
    "headers": null
  },
  {
    "topic": "b",
    "key": null,
    "value": {
      "lookedUpName": "Mr. Devora Bartell",
      "lookedUpNumber": 10
    },
    "headers": null
  },
  {
    "topic": "a",
    "key": {
      "name": "Timothy Bernhard V",
      "magicNumber": 82
    },
    "value": null,
    "headers": null
  },
  {
    "topic": "b",
    "key": null,
    "value": {
      "lookedUpName": "Mr. Devora Bartell",
      "lookedUpNumber": 10
    },
    "headers": null
  },
  {
    "topic": "a",
    "key": {
      "name": "Elroy Nader",
      "magicNumber": 44
    },
    "value": null,
    "headers": null
  },
  {
    "topic": "b",
    "key": null,
    "value": {
      "lookedUpName": "Tiffani Schaden",
      "lookedUpNumber": 68
    },
    "headers": null
  },
  {
    "topic": "a",
    "key": {
      "name": "Denny Mayer III",
      "magicNumber": 45
    },
    "value": null,
    "headers": null
  },
  {
    "topic": "b",
    "key": null,
    "value": {
      "lookedUpName": "Denny Mayer III",
      "lookedUpNumber": 45
    },
    "headers": null
  }
]

```

--------------------------------

### Example Maintenance Notification Event

Source: https://docs.shadowtraffic.io/overview

An example of a maintenance notification event generated by ShadowTraffic, which includes a sensor ID that was likely retrieved using the 'lookup' function.

```json
{
    "topic" : "maintenanceNotifications",
    "value" : {
      "sensorId" : "a2c57eea-0589-70f8-b557-25e7ebb399c4",
      "status" : "needs repair"
    }
}

```

--------------------------------

### Lookup Last Event Output Example

Source: https://docs.shadowtraffic.io/functions/lookup

Example output demonstrating how the 'last' lookup strategy causes each 'b' value to lock onto the most recent generated value of 'a'.

```json
[
    {
        "topic": "a",
        "key": null,
        "value": 110.93893101788113,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": 110.93893101788113,
        "headers": null
    },
    {
        "topic": "a",
        "key": null,
        "value": 89.14192828994,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": 89.14192828994,
        "headers": null
    },
    {
        "topic": "a",
        "key": null,
        "value": 94.35940089737974,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": 94.35940089737974,
        "headers": null
    },
    {
        "topic": "a",
        "key": null,
        "value": 108.36103500448338,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": 108.36103500448338,
        "headers": null
    },
    {
        "topic": "a",
        "key": null,
        "value": 106.61900083698767,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": 106.61900083698767,
        "headers": null
    }
]

```

--------------------------------

### Set File Format and Compression

Source: https://docs.shadowtraffic.io/connections/filesystem

Configures the filesystem connection to write IP address data with specific formatting and compression. This example uses JSON format with pretty printing enabled and includes a timestamp.

```json
{
    "generators": [
        {
            "directory": "/tmp/data",
            "fileConfigs": {
                "filePrefix": "ipAddresses-",
                "format": "json",
                "pretty": true
            },
            "data": {
                "ip": {
                    "_gen": "string",
                    "expr": "#{Internet.ipV4Address}"
                },
                "timestamp": {
                    "_now": "now"
                }
            }
        }
    ],
    "connections": {
        "localFs": {
            "kind": "fileSystem"
        }
    }
}
```

--------------------------------

### Call Bedrock AI

Source: https://docs.shadowtraffic.io/functions/ai

Shows how to integrate with AWS Bedrock. Set 'service' to 'bedrock' and provide the model ID and prompt. The example requires a placeholder 'xxx' for the modelId.

```json
{
    "_gen": "ai",
    "service": "bedrock",
    "bedrock": {
        "modelId": "xxx",
        "prompt": "Write a two sentence incident report for a software bug."
    }
}

```

--------------------------------

### Get Last Event with Path

Source: https://docs.shadowtraffic.io/functions/previousEvent

This snippet demonstrates how to use previousEvent to retrieve the 'value' field from the last event. It's combined with oneOf to either get the previous event's value or a random number.

```json
{
    "_gen": "oneOf",
    "choices": [
        {
            "_gen": "previousEvent",
            "path": [
                "value"
            ]
        },
        {
            "_gen": "uniformDistribution",
            "bounds": [
                1,
                4
            ]
        }
    ]
}
```

```json
[
    {
        "topic": "sandbox",
        "key": null,
        "value": null,
        "headers": null
    },
    {
        "topic": "sandbox",
        "key": null,
        "value": null,
        "headers": null
    },
    {
        "topic": "sandbox",
        "key": null,
        "value": null,
        "headers": null
    },
    {
        "topic": "sandbox",
        "key": null,
        "value": 1.1927970089568882,
        "headers": null
    },
    {
        "topic": "sandbox",
        "key": null,
        "value": 1.82519991472889,
        "headers": null
    }
]
```

--------------------------------

### Example Output with Variable Lookup

Source: https://docs.shadowtraffic.io/functions/lookup

This snippet shows the output generated by the events defined previously. It illustrates how event 'b' successfully retrieves the 'x' and 'y' variables used in event 'a' for each execution, demonstrating the variable lookup functionality.

```json
[
    {
        "topic": "a",
        "key": null,
        "value": 104.29258605868415,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": {
            "result": {
                "x": 54.18051750224169,
                "y": 50.11206855644246
            }
        },
        "headers": null
    },
    {
        "topic": "a",
        "key": null,
        "value": 67.37253098813049,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": {
            "result": {
                "x": 54.18051750224169,
                "y": 13.192013485888799
            }
        },
        "headers": null
    },
    {
        "topic": "a",
        "key": null,
        "value": 69.548597046074,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": {
            "result": {
                "x": 54.18051750224169,
                "y": 15.368079543832302
            }
        },
        "headers": null
    }
]

```

--------------------------------

### Example Kafka Topic Data

Source: https://docs.shadowtraffic.io/functions/lookup

This JSON array represents example data that might be produced or consumed from Kafka topics 'a' and 'b' based on the configuration above. It shows messages with keys on topic 'a' and corresponding values on topic 'b'.

```json
[
    {
        "topic": "a",
        "key": {
            "id": "Ms. Shakira McLaughlin"
        },
        "value": null,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": "Ms. Shakira McLaughlin",
        "headers": null
    },
    {
        "topic": "a",
        "key": {
            "id": "Santiago Rolfson"
        },
        "value": null,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": "Ms. Shakira McLaughlin",
        "headers": null
    },
    {
        "topic": "a",
        "key": {
            "id": "Marlena Little Sr."
        },
        "value": null,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": "Ms. Shakira McLaughlin",
        "headers": null
    },
    {
        "topic": "a",
        "key": {
            "id": "Olevia Emmerich Sr."
        },
        "value": null,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": "Marlena Little Sr.",
        "headers": null
    },
    {
        "topic": "a",
        "key": {
            "id": "Billy Cummings DDS"
        },
        "value": null,
        "headers": null
    },
    {
        "topic": "b",
        "key": null,
        "value": "Ms. Shakira McLaughlin",
        "headers": null
    }
]

```

--------------------------------

### Pub/Sub Connection with Emulator

Source: https://docs.shadowtraffic.io/connections/pubsub

Connects to a Pub/Sub emulator for testing purposes. Set emulatorHost to the emulator's connection string. The GOOGLE_APPLICATION_CREDENTIALS environment variable is not required.

```json
{
    "connections": {
        "pubSubTransient": {
            "kind": "pubsub",
            "connectionConfigs": {
                "emulatorHost": "http://localhost:8085"
            }
        }
    }
}

```
Tokens:
Raw