Moesif

https://www.moesif.com/docs
Admin
Moesif is an API analytics and monitoring platform that provides insights into API usage, user...
Tokens:322,458
Snippets:3,862
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install and Start Webhook Service

Source: https://www.moesif.com/docs/extensions/auth0

Install dependencies and start the local webhook service for testing. Ensure your MOESIF APPLICATION ID is correctly configured.

```bash
$ npm install # If running yourself
added XX packages from XX contributors in XX.XXs

$ npm start # If running yourself
Listening on port 3050
```

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

### Compile Spring Boot Starter Example with Maven

Source: https://www.moesif.com/docs/server-integration/servlet

Compile and install the Spring Boot starter example using Maven.

```bash
cd spring-boot-starter-example
mvn clean install
```

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

### Install Moesif Gin Middleware

Source: https://www.moesif.com/docs/server-integration/gin

Use `go get` to install the Moesif Gin middleware with the specified version for Go modules.

```bash
go get github.com/moesif/moesifgin@v1.0.0

```

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

### Compile and Run Jersey Servlet Example

Source: https://www.moesif.com/docs/server-integration/servlet

Build the Jersey servlet example using Maven and run it with webapp-runner. This command compiles the project, packages it, and starts a web server.

```bash
cd jersey-servlet-example
mvn clean install
java -jar target/dependency/webapp-runner.jar target/*.war
```

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

### Install Moesif Middleware for Go

Source: https://www.moesif.com/docs/server-integration/go

Use 'go get' to install the Moesif middleware. Specify a version number if using Go modules.

```bash
go get github.com/moesif/moesifmiddleware-go

```

```bash
go get github.com/moesif/moesifmiddleware-go@v1.2.3

```

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

### Clone Moesif Servlet Repository

Source: https://www.moesif.com/docs/server-integration/servlet

Download the Moesif servlet integration examples from GitHub. Navigate into the cloned directory to proceed with setup.

```bash
git clone https://github.com/Moesif/moesif-servlet
cd moesif-servlet/
```

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

### Compile and Run Spark Servlet Example

Source: https://www.moesif.com/docs/server-integration/servlet

Build the Spark servlet example using Maven and execute it with webapp-runner. This process compiles the code, creates a WAR file, and starts the embedded server.

```bash
cd spark-servlet-example
mvn clean install
java -jar target/dependency/webapp-runner.jar target/*.war
```

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

### Docker Compose Setup

Source: https://www.moesif.com/docs/server-integration/ballerina

Command to start the Docker stack, which includes components like the OpenTelemetry Collector and potentially Fluent Bit.

```bash
docker compose up

```

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

### Run Strapi Development Server

Source: https://www.moesif.com/docs/server-integration/strapi

Start your Strapi development server using npm or yarn after installation and configuration.

```bash
npm run develop

```

```bash
yarn develop

```

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

### Run Spring Boot Starter Example with Maven

Source: https://www.moesif.com/docs/server-integration/servlet

Run the compiled Spring Boot starter example.

```bash
java -jar target/spring-boot-starter-example*.jar
```

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

### Configure OkHttp Client with Moesif Interceptor (Kotlin)

Source: https://www.moesif.com/docs/server-integration/okhttp

Build an OkHttp client and add the MoesifOkHttp3Interceptor. This example shows how to make a synchronous GET request and print headers and body.

```kotlin
import com.moesif.sdk.okhttp3client.MoesifOkHttp3Interceptor

val client = OkHttpClient.Builder()
 .addInterceptor(MoesifOkHttp3Interceptor()) // The only modification to official sample
 .build()

val request = Request.Builder()
 .url("https://publicobject.com/helloworld.txt")
 .build()

client.newCall(request).execute().use { response ->
  if (!response.isSuccessful) throw IOException("Unexpected code $response")
  for ((name, value) in response.headers) {
    println("$name: $value")
  }
println(response.body!!.string())
}
```

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

### Bundle Install Command

Source: https://www.moesif.com/docs/guides/integrating-api-analytics-with-rails-ruby-rack

After adding the gem to your Gemfile, run `bundle install` to install it. This command fetches and installs all gems specified in your Gemfile.

```bash
Bundle install
```

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

### Install Moesif AWS Lambda Go Middleware

Source: https://www.moesif.com/docs/server-integration/aws-lambda-go

Install the Moesif AWS Lambda Go middleware using go get. Specify a version number if using Go Modules.

```bash
go get github.com/moesif/moesif-aws-lambda-go
```

```bash
go get github.com/moesif/moesif-aws-lambda-go@v1.0.3
```

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

### Start Moesif Developer Portal API

Source: https://www.moesif.com/docs/developer-portal/developer-portal-overview

Run this command in the `./my-dev-portal-api` directory to start the backend API project.

```bash
node app.js

```

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

### Configure OkHttp Client with Moesif Interceptor (Java)

Source: https://www.moesif.com/docs/server-integration/okhttp

Instantiate an OkHttpClient and add the MoesifOkHttp3Interceptor. This Java example demonstrates a synchronous GET request, logging response headers and body.

```java
import com.moesif.sdk.okhttp3client.MoesifOkHttp3Interceptor;

private final OkHttpClient client = new OkHttpClient.Builder()
 .addInterceptor(new MoesifOkHttp3Interceptor()) // The only modification to official sample
 .build();

public void run() throws Exception {
 Request request = new Request.Builder()
   .url("https://publicobject.com/helloworld.txt")
   .build();
 try (Response response = client.newCall(request).execute()) {
   if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
   Headers responseHeaders = response.headers();
   for (int i = 0; i < responseHeaders.size(); i++) {
      System.out.println(responseHeaders.name(i) + ": " +  responseHeaders.value(i));
   }
   System.out.println(response.body().string());
   }
}
```

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

### Download Istio Installer

Source: https://www.moesif.com/docs/server-integration/envoy-lua-plugin

Use this command to download the Istio installation script for Linux or macOS.

```bash
curl -L https://istio.io/downloadIstio | sh -
```

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

### Install npm packages

Source: https://www.moesif.com/docs/developer-portal/setup-auth0-m2m-plugin

Install necessary npm packages for the project. This is a prerequisite for uploading the authorizer.

```bash
npm install
```

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

### Install Moesif ASGI Middleware

Source: https://www.moesif.com/docs/server-integration/python-asgi

Install the moesif-asgi package using pip.

```bash
pip install moesifasgi

```

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

### Start Application with Docker Compose

Source: https://www.moesif.com/docs/guides/api-observability-and-monetization-with-openresty

Start the OpenResty application and its related services using Docker Compose.

```bash
docker compose up
```

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

### Run Spring Boot Starter Example with Maven (Alternative)

Source: https://www.moesif.com/docs/server-integration/servlet

An alternative command to run the Spring Boot starter example directly using Maven.

```bash
mvn  spring-boot:run
```

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

### Clone Moesif Envoy WASM Plugin Repository

Source: https://www.moesif.com/docs/server-integration/envoy-wasm-plugin

Clone the Moesif Envoy WASM plugin repository to get started with the example configurations and Docker Compose setup.

```bash
git clone https://github.com/Moesif/moesif-envoy-wasm-plugin.git
cd moesif-envoy-plugin/examples/envoy

```

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

### Start Minikube with Sufficient Resources

Source: https://www.moesif.com/docs/server-integration/envoy-wasm-plugin

Start a Minikube instance with allocated CPUs and memory required for Istio and the WASM plugin.

```bash
minikube start --cpus 4 --memory 8192

```

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

### Complete main.go with Moesif Integration

Source: https://www.moesif.com/docs/guides/guide-on-integrating-api-analytics-with-go-rest-api

This is a complete example of a main.go file demonstrating the Moesif integration. It includes the SDK import, middleware configuration, and a sample handler for fetching a credit score.

```go
package main

import (
   "encoding/json"
   "log"
   "math/rand"
   "net/http"


   moesifmiddleware "github.com/moesif/moesifmiddleware-go"
)

var moesifOptions = map[string]interface{}{
   "Application_Id": "MOESIF_APPLICATION_ID",
}

const creditScoreMin = 500
const creditScoreMax = 900

type credit_rating struct {
   CreditRating int `json:"credit_rating"`
}

func handleRequests() {
   http.Handle("/creditscore", moesifmiddleware.MoesifMiddleware(http.HandlerFunc(getCreditScore), moesifOptions))
   log.Fatal(http.ListenAndServe(":8080", nil))
}

func main() {
   handleRequests()
}

func getCreditScore(w http.ResponseWriter, r *http.Request) {
   var creditRating = credit_rating{CreditRating: (rand.Intn(creditScoreMax-creditScoreMin) + creditScoreMin)}


   w.WriteHeader(http.StatusOK)
   json.NewEncoder(w).Encode(creditRating)
}


```

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

### Example package.json for Embedded Templates

Source: https://www.moesif.com/docs/guides/guide-on-creating-and-using-embedded-templates-in-moesif

This is an example of a package.json file after installing the required dependencies. It lists dotenv, express, and node-fetch as dependencies.

```json
{
  "name": "embedded-simple",
  "version": "1.0.0",
  "description": "",
  "main": "server.js",
  "author": "",
  "license": "ISC",
  "dependencies": {
    "dotenv": "^16.0.0",
    "express": "^4.17.3",
    "node-fetch": "^2.6.7"
  },
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  }
}

```

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

### API Gateway GET Request Response

Source: https://www.moesif.com/docs/guides/how-to-setup-moesif-developer-portal-with-aws-api-gateway

Example response from a GET request to the API Gateway endpoint, which forwards requests to JSONPlaceholder.

```json
[
  {
    "userId": 1,
    "id": 2,
    "title": "qui est esse",
    "body": "est rerum tempore vitae\nsequi sint nihil reprehenderit dolor beatae ea dolores neque\nfugiat blanditiis voluptate porro vel nihil molestiae ut reiciendis\nqui aperiam non debitis possimus qui neque nisi nulla"
  },
  {
    "userId": 1,
    "id": 3,
    "title": "ea molestias quasi exercitationem repellat qui ipsa sit aut",
    "body": "et iusto sed quo iure\nvoluptatem occaecati omnis eligendi aut ad\nvoluptatem doloribus vel accusantium quis pariatur\nmolestiae porro eius odio et labore et velit aut"
  },
  {
    "userId": 1,
    "id": 4,
    "title": "eum et est occaecati",
    "body": "ullam et saepe reiciendis voluptatem adipisci\nsit amet autem assumenda provident rerum culpa\nquis hic commodi nesciunt rem tenetur doloremque ipsam iure\nquis sunt voluptatem rerum illo velit"
  },
  /*snip*/
]
```

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

### Install Istio with Demo Profile

Source: https://www.moesif.com/docs/server-integration/envoy-lua-plugin

Install Istio using the demo profile, which provides a good set of default configurations for testing purposes.

```bash
istioctl install --set profile=demo
```

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

### Get Metadata Example

Source: https://www.moesif.com/docs/server-integration/django

Example function to capture custom metadata like IP address and user agent. This enriches event data with contextual information.

```python
def get_metadata(request, response):
    return {
        "ip_address": request.META.get('REMOTE_ADDR'),
        "user_agent": request.META.get('HTTP_USER_AGENT')
    }

MOESIF_MIDDLEWARE = {
    "APPLICATION_ID": "YOUR_APPLICATION_ID",
    "GET_METADATA": get_metadata
}

```

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

### Compile and Run Servlet Example

Source: https://www.moesif.com/docs/server-integration/servlet

Build the servlet example using Maven and run the application using `webapp-runner.jar`. Ensure your Moesif Application ID is configured in `web.xml`.

```bash
cd servlet-example
mvn clean install
java -jar target/dependency/webapp-runner.jar target/*.war

```

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

### Install Moesif Go SDK

Source: https://www.moesif.com/docs/guides/guide-on-integrating-api-analytics-with-go-rest-api

Use this command to add the Moesif Go middleware SDK to your project. Ensure you are in your project's root directory.

```bash
go get github.com/moesif/moesifmiddleware-go

```

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

### Get Session Token Example

Source: https://www.moesif.com/docs/server-integration/django

Example function to retrieve the session token from Django's session object. This aids in replaying events and tracking user sessions.

```python
def get_session_token(request, response):
    return request.session.session_key

MOESIF_MIDDLEWARE = {
    "APPLICATION_ID": "YOUR_APPLICATION_ID",
    "GET_SESSION_TOKEN": get_session_token
}

```

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

### Start Moesif Developer Portal UI

Source: https://www.moesif.com/docs/developer-portal/developer-portal-overview

Run this command in the `./my-dev-portal` directory to start the React frontend application. Your browser will then open to `http://127.0.0.1:4000`.

```bash
npm start

```

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

### Instrument GET /todos/:id Request

Source: https://www.moesif.com/docs/guides/guide-on-integrating-opentelemetry-traces

This snippet shows how to start and end a span for a GET request to retrieve a specific todo item. It includes adding attributes to the span for context.

```javascript
app.get("/todos/:id", async (req, res) => {
  const todo = await findTodoFromDb(parseInt(req.params.id));

  // Start a new span
  const span = tracer.startSpan("get-todo-by-id");

  // Add attributes to the span
  span.setAttributes({
    "user.id": "userstuff",
    "company.id": "company2",
    "http.route": "/todos",
    "http.status_code": 200,
    "traceId": span.spanContext().traceId,
  });

  res.json(todo);
  span.end(); // End the span
});
```

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

### Install and Run moesif-eth-cli

Source: https://www.moesif.com/docs/platform/ethereum-web3

Install the Moesif Ethereum command-line tools globally using npm. Then, run the tool to upload compiled smart contracts by specifying the contract directory and your Moesif Management API token.

```bash
$ npm install -g moesif-eth-cli
moesif-eth -f ./build/contracts -t MOESIF_MANAGEMENT_API_TOKEN
```

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

### Run .NET Core Application

Source: https://www.moesif.com/docs/guides/integrating-api-analytics-with-dotnet-core

Start your .NET Core server to begin receiving API requests. If you encounter build issues, try cleaning and rebuilding the project first.

```bash
dotnet run
```

```bash
dotnet clean && dotnet build && dotnet run
```

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

### Full Node.js GraphQL API Example with Moesif

Source: https://www.moesif.com/docs/guides/guide-on-integrating-api-analytics-with-nodejs-graphql-api

A complete example of a Node.js GraphQL API using Express and Apollo Server, integrated with Moesif middleware. This demonstrates the complete setup for analytics.

```javascript
const express = require('express');
const { ApolloServer, gql } = require('apollo-server-express');
const moesif = require('moesif-nodejs');

// Construct a schema, using GraphQL schema language
const typeDefs = gql`
  type Query {
    data1: String
    data2: String
    data3: String
  }
`;

// Provide resolver functions for your schema fields
const resolvers = {
  Query: {
    data1: () => 'some data',
    data2: () => 'some more data',
    data3: () => 'even more data',
  },
};

const server = new ApolloServer({ typeDefs, resolvers });

const app = express();
server.start();

var moesifMiddleware = moesif({
    applicationId: 'MOESIF_APPLICATION_ID',

    identifyUser: function (req, res) {
        return req.user ? req.user.id : undefined;
    },
});

app.use(moesifMiddleware);
server.applyMiddleware({ app });

app.listen({ port: 4000 }, () =>
  console.log(`🚀 Server ready at http://localhost:4000${server.graphqlPath}`)
);

```

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

### Check Maven Version

Source: https://www.moesif.com/docs/server-integration/servlet

Verify that Maven version 3.0.x or above is installed before running the Spring Boot starter example.

```bash
mvn -v
```

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

### Start Local Server

Source: https://www.moesif.com/docs/guides/guide-on-creating-and-using-embedded-templates-in-moesif

Run this command in your project's root directory to start the local server that serves the embedded dashboard.

```bash
node server.js
```

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

### Start Developer Portal with Docker Compose

Source: https://www.moesif.com/docs/developer-portal/using-the-developer-portal

Launch the Developer Portal services defined in docker-compose.yml using Docker Compose.

```bash
 docker-compose up -d

```

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

### Get Session Token from Request Header

Source: https://www.moesif.com/docs/server-integration/servlet

Override this method to manually define the session token or API key. This example retrieves it from the 'Authorization' header.

```java
  @Override
  public String getSessionToken(HttpServletRequest request, HttpServletResponse response) {
    return request.getHeader("Authorization");
  }

```

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

### Get API Version from Request Header

Source: https://www.moesif.com/docs/server-integration/servlet

Override this method to return a string that tags requests with a specific API version. This example reads the version from the 'X-Api-Version' header.

```java
  @Override
  public String getApiVersion(HttpServletRequest request, HttpServletResponse response) {
    return request.getHeader("X-Api-Version");
  }

```

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

### Moesif Configuration Example

Source: https://www.moesif.com/docs/server-integration/nginx-plus

An example nginx.conf snippet demonstrating various Moesif directives for enabling the module, setting application ID, sync interval, cache size, metadata, and user/company ID headers.

```nginx
http{
    # turn on Moesif  function
    moesif  on;
    moesif_application_id  your-moesif-application-id;  # required field
    moesif_sync_interval 1;  # optional field to configure how often API data is sent, defaults to 2 seconds
    moesif_events_cache_size 50;  # optional field to configure events cache size, defaults to 25
    moesif_metadata type http;    # optional metadata
    ...
    server {
        server_name example.com;
        
        moesif_metadata server east-1; #optional metadata

        location /loc1 {
                #moesif data is captured since moesif is on at a global level
            moesif_user_id_header  X-USER-ID;
            moesif_company_id_header X-COMPANY_ID;
            moesif_api_version_header X-API-VERSION; 
            moesif_api_weight  1;
            ...
            proxy_pass 127.0.0.1:8080
        }
        
        location /loc2 {
            moesif  off;  # moesif disabled. No API events captured at this location  
            ...
     
        }
        
        location /loc3 {
            moesif  on;
            moesif_skip_body on; # body is not captured at this location
            moesif_metadata api mgmt; #optional metadata, all the metadata above is inherited
            ...
     
        }
        
    }

}
```

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

### Full Flask App with Moesif Integration

Source: https://www.moesif.com/docs/guides/integrating-api-analytics-with-python-flask

A complete example of a Flask application file demonstrating the integration of Moesif middleware. This includes basic Flask setup, API code placeholders, and the Moesif middleware configuration applied before running the app.

```python
from flask import Flask, jsonify, request
from moesifwsgi import MoesifMiddleware
import json

app = Flask(__name__)

...
...

# API CODE

...
...

if __name__ == '__main__':
   moesif_settings = {
       'APPLICATION_ID': 'YOUR_MOESIF_APP_ID',
       'CAPTURE_OUTGOING_REQUESTS': False, # Set to True to also capture outgoing calls to 3rd parties.
   }
   app.wsgi_app = MoesifMiddleware(app.wsgi_app, moesif_settings)
   app.run(port=5000)

```

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

### Moesif Telemetry Configuration in Krakend

Source: https://www.moesif.com/docs/server-integration/krakend

Example Krakend configuration for enabling Moesif telemetry. This setup pushes user activity to Moesif, identifying users via JWT claims and companies via a specified JWT claim. It configures logging, event queue size, batch size, and the timer for sending events.

```json
{
  "version": 3,
  "extra_config": {
    "telemetry/moesif": {
      "@comment": "Push user activity to Moesif based on the information contained in JWT, every second, in batches of 1000 events",
      "application_id": "yourapplicationid",
      "user_id_headers": [
        "Authorization"
      ],
      "user_id_jwt_claim": "sub",
      "identify_company": {
        "jwt_claim": "company_id"
      },
      "debug": false,
      "log_body": false,
      "event_queue_size": 1000000,
      "batch_size": 1000,
      "timer_wake_up_seconds": 1
    }
  }
}

```

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

### Install Moesif Luarock

Source: https://www.moesif.com/docs/server-integration/nginx-openresty

Install the Moesif Lua plugin using luarocks. Ensure you have lua-nginx-module installed.

```bash
luarocks install --server=http://luarocks.org/manifests/moesif lua-resty-moesif

```

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

### Start Developer Portal Frontend Command

Source: https://www.moesif.com/docs/guides/guide-api-monetization-with-apigee-and-moesif-developer-portal

Run this command in your terminal to start the developer portal's frontend application.

```bash
npm start
```

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

### Install Moesif AWS Lambda Middleware

Source: https://www.moesif.com/docs/server-integration/aws-lambda-python

Install the middleware using pip. Ensure you have Python and pip installed.

```bash
pip install moesif_aws_lambda

```

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

### Build and Start Envoy Services with Docker Compose

Source: https://www.moesif.com/docs/server-integration/envoy-wasm-plugin

Use Docker Compose to build the WASM binary and start the Envoy proxy and echo server for testing.

```bash
docker-compose up --build

```

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

### Troubleshoot Kong Plugin Installation Warning

Source: https://www.moesif.com/docs/server-integration/kong-ingress-controller

This warning indicates missing dependencies required for plugin installation. Ensure 'unzip' is installed to resolve this.

```bash
Warning: Failed searching manifest: Failed extracting manifest file: 'unzip -n' program not found. Make sure unzip is installed and is available in your PATH (or you may want to edit the 'variables.UNZIP' value in file '/usr/local/etc/luarocks/config-5.1.lua')
Warning: Failed searching manifest: Failed extracting manifest file: 'unzip -n' program not found. Make sure unzip is installed and is available in your PATH (or you may want to edit the 'variables.UNZIP' value in file '/usr/local/etc/luarocks/config-5.1.lua')

Error: No results matching query were found for Lua 5.1.
To check if it is available for other Lua versions, use --check-lua-versions.
```

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

### Install unzip package using apt

Source: https://www.moesif.com/docs/server-integration/kong-api-gateway

Install the 'unzip' package, which is required for installing Kong plugins. This command uses the apt package manager.

```bash
apt-get update; apt-get install curl vim unzip
```

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

### Navigate to Istio Directory

Source: https://www.moesif.com/docs/server-integration/envoy-lua-plugin

Change into the downloaded Istio package directory to access its tools.

```bash
cd istio-1.9.2
```

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

### Install Moesif Rack Gem

Source: https://www.moesif.com/docs/guides/integrating-api-analytics-with-rails-ruby-rack

Install the Moesif Rack gem using the `gem install` command. This makes the Moesif middleware available in your project.

```bash
gem install moesif_rack
```

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

### Install Moesif Rack Gem

Source: https://www.moesif.com/docs/server-integration/rack

Install the Moesif gem to add its middleware capabilities to your Ruby application. If using Bundler, add it to your Gemfile and run bundle install.

```ruby
gem install moesif_rack
```

```ruby
gem 'moesif_rack'
```

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

### Enable Moesif SDK with YAML Configuration

Source: https://www.moesif.com/docs/server-integration/symfony

Configure the Moesif SDK by creating a `moesif.yaml` file in `config/packages`. This example shows basic configuration including the application ID and debug settings.

```yaml
moesif:
  moesif_application_id: 'YOUR_MOESIF_APPLICATION_ID.'
  debug: false
  options:
    max_queue_size: 50
    max_batch_size: 25
  hooks_class: 'App\Configuration\MyMoesifHooks'

```
Tokens:
Raw