Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

192x192

Upstream

Upstream npm version npm downloads License Build

This is a passion project I've been developing for the past few months, and using it internally across my apps. I needed a simple logging platform that was quick to setup for new projects, had awesome logging capabilities, and beautiful UI. This is what I came up with.

Basically, Upstream is a easy way to integrate logging into your own applications. It takes minutes to setup - you create a account, project, API key, and integrate it with your project using my SDK. Upstream is currently closed source for now. However, I might open source it in the future.

image

I want to try Upstream!

  1. Go to https://up.linus.my and register an API key for your project.
  2. Install upstream-sdk
npm i upstream-sdk
  1. Start ingesting events, below is an example.
import { Upstream } from 'upstream-sdk'

const up = new Upstream("YOUR_API_KEY")

up.events.ingest({
    title: "Project Deployed",
    icon: "😁",
});

That's just scratching the surface. You can log complex events with json, events, descriptions, fields, and even add action buttons.

Field Type Required Example
title string Yes "Payment Processed"
icon string Yes "💰"
category string No "billing"
content string No "Your subscription was renewed successfully."
fields Field[] No [{"name":"Plan","value":"Pro"}]
events TimelineEvent[] No [{"icon":"✅","time":"12:00 PM","content":"Subscription renewed."}]
data unknown No {"subscriptionId":"sub_abc123"}
actions Action[] No [{"title":"View Invoice","type":"default","url":"https://example.com"}]

License

Licensed under CC BY-NC 4.0. See LICENSE for more.

Built with ❤️ by Linus Kang

About

Simple and open logging for your next project.

Topics

Resources

Stars

Watchers

Forks

Releases

Contributors

Languages