Skip to content

Commit

Permalink
feat: initial Lens extension that formats logging with bunyan
Browse files Browse the repository at this point in the history
  • Loading branch information
jdinsel-xealth committed May 22, 2023
1 parent 52ccf60 commit 4059ccf
Show file tree
Hide file tree
Showing 6 changed files with 20,498 additions and 31 deletions.
34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,29 @@
# bunyan-lens-ext README

This is the README for your extension "bunyan-lens-ext". After writing up a brief description, we recommend including the following sections.
The bunyan-lens-ext provides a bunyan log viewer for Lens. Inspiration came from
the [lens-mutli-pod-logs](https://github.com/andrea-falco/lens-multi-pod-logs) extension.

## Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under your extension project workspace:

\!\[feature X\]\(images/feature-x.png\)

> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
This plugin adds a menu item to the Pods menu in Lens. When clicked, it will open a new terminal with the bunyan log viewer.

## Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
Install bunyan globally:

```bash
npm install -g bunyan
```

## Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.
None.

## Release Notes

Users appreciate release notes as you update your extension.

### 1.0.0

Initial release of ...

### 1.0.1

Fixed issue #.
Enjoy!

### 1.1.0
### 0.0.1

Added features X, Y, and Z.
Initial release of the bunyan-lens-ext contains minimal functionality and allows
for the viewing of Logs through the use of the `bunyan` command line tool.
5 changes: 3 additions & 2 deletions main.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { Main } from "@k8slens/extensions";

import { Renderer } from "@k8slens/extensions"

/**
* Main.LensExtension api allows you to access, configure, and customize Lens data add
Expand All @@ -7,7 +8,7 @@ import { Main } from "@k8slens/extensions";
*
* See more details: <https://docs.k8slens.dev/>
*/
export default class YourExtensionMain extends Main.LensExtension {
export default class BunyanExtensionMain extends Renderer.LensExtension {
/**
* onActivate is called when your extension has been successfully enabled.
*/
Expand Down
Loading

0 comments on commit 4059ccf

Please sign in to comment.