Table of Contents

Features

Screenshots

Requirements

Compatibility

Limitations

Installation

pip

pip install tygenie

pipx

pipx install git+https://github.com/ovh/tygenie.git

uv

uv tool install git+https://github.com/ovh/tygenie.git

Start the application

tygenie

$ tygenie --helpusage: tygenie [-h] [--config CONFIG]options:  -h, --help            show thishelp message andexit  --config CONFIG, -c CONFIG

Configuration

{// Opsgenie configuration partopsgenie:{api_key:"",//                                                     Your Opsgenie integration API keyusername:"",//                                                    Your Opsgenie usernamehost:"https://api.eu.opsgenie.com",//                             Opsgenie API endpointwebapp_url:"https://app.eu.opsgenie.com",//                       The Web URL to access Opsgenie from your web browseron_call_schedule_ids:[],},// Tygenie configuration parttygenie:{refresh_period:60,//                                              Number of seconds between 2 automatic refresh (min 60s)open_detail_alert_on_enter:false,//                               If you don't want tygenie to automatically load alert details set it to true and press enter to get the detailslog:{enable:false,//                                                 Will enable API loggingfile:"/tmp/tygenie.log",//                                      Path where the log will be written},desktop_notification:{enable:true,//                                                  To enable desktop notification when new alerts are detected set it to trueurgency:"Critical",//                                           Urgency level: can be Critical, Normal, Lowwhen_on_call_only:false,//                                      When enable is true will send notification only when you are on call},alert_details:{default_tab:"description",//                                    Default tab displayed when loading alert details, values might be: RAW, tags, details, description},alerts:{date_format:"%d/%m %H:%M",//                                    Date formatsort:"updatedAt",//                                             Field used to sort alerts when doing API calllimit:20,//                                                     Number of alerts to displaydisplay_page_by_priority:false,//                               To sort by priority set it to true},note_on_ack:{enable:false,//                                                 To automatically add a note when acking an alert set it to truemessage:"Alert has been acknowledged using Tygenie",//          Note to be added},note_on_unack:{enable:false,//                                                 To automatically add a note when unacking an alert set it to truemessage:"Alert has been unacknowledged using Tygenie",//        Note to be added},note_on_close:{enable:false,//                                                 To automatically add a note when closing an alert set it to truemessage:"Alert has been closed using Tygenie",//                Note to be added},note_on_tag:{enable:false,//                                                 To automatically add a note when adding a tag on alert set it to truemessage:"Tag '{tag}' has been added using Tygenie",//           Note to be added, you might use '{tag}' notation to add the value of the tag in the note},note_on_untag:{enable:false,//                                                 To automatically add a note when removing a tag on alert set it to truemessage:"Tag '{tag}' has been removed using Tygenie",//         Note to be added, you might use '{tag}' notation to add the value of the tag in the note},keybindings:{//                                                                Keybindings for each actionsack:"a",//                                                      to ack an alertunack:"U",//                                                    to unack an alertclose:"c",//                                                    to close an alerttag:"t",//                                                      to tag an alertuntag:"T",//                                                    to untag an alertrefresh:"r",//                                                  to manually refresh alert listnext_page:"right",//                                            load next page (will also work with page down, G, down key on last alert)previous_page:"left",//                                         load previous page (will also work with page up, g, up key on first alert)open_in_webbrowser:"ctrl+w",//                                  to open the selected alert in your default web browserfocus_on_alerts_list:"f5",// to get focus on alert list},plugins:{alert_formatter:null,//                                         plugin name to use to display alert list (you might customize columns, messages, ... check plugin part)content_transformer:null,//                                     plugin name to use to that allow you to parse alert detail and customize the rendered markdown},default_tag:"XXXXX",//                                            default tag to apply to an alertdefault_filter:"opened",//                                        default defined filter to use hen starting the applicationfilters:{//                                                                define your query filters heremine:{//                                                              mine filter will display the alert you are the owner of when using 'm' keykey:"m",filter:"owner:<your username>",description:"Mine",},opened:{key:"o",//                                                    opened filter will display opened alerts only when using key 'o'filter:"status:open",description:"Opened",},all:{key:"A",//                                                    All filter, will display all the alertsfilter:"",description:"All",},},},}

Sample config

Plugin

Add your own plugin

Customise alert list

fromrich.textimportTextfromtygenie.alerts_list.formatterimportBaseFormatter# The class name must be the same as the plugin nameclassBob(BaseFormatter):# map method of the class with a column name# the dict is ordered so it will be displayed as it is declared# all the fields returned by the API are available by defaultdisplayed_fields= {"created_at":"Created","status":"Status","priority":"Priority","region":"Region",# Custom field"message":"Message","owner":"Owner","closed_by":"Closed by",    }# Let's add a custom field that we compute from the message# And return a rich Text object which allow us to customise the styledefregion(self,value)->Text:m=re.match(r"^\[([^\[]+)\].*$",self.to_format["message"])region=""ifmandm.groups():region=m.group(1)returnText(region,style="#ffcf56")# Remove the region from the message as region is now a new column# And limit the length to 100 characters# And return a rich Text object with default styledefmessage(self,value)->Text:value=re.sub(r"^\[([^\[]+)\]\s*\:?\s*","",value)iflen(value)>100:value=value[0:100]+"..."returnText(str(value))

Customise alert description

importrefromtygenie.alert_details.description_formatterimportBaseContentFormatterclassBob(BaseContentFormatter):def__init__(self,**kwargs):super().__init__(**kwargs)self.execution_order["pre"]= ["pre_substitute_cariage_return_to_htmlttag",        ]self.execution_order["post"]= ["post_custom_generate_url_by_id",        ]# pre_substitute_* is a special form of method name that does the substitute for you# Just return a dict {"regexp": r"your regexp to match", "sub": r"the substitution"}defpre_substitute_cariage_return_to_htmlttag(self):return {"regexp":r"\r?\n","sub":"<br>"}# Let's say your description return a list of ids you can easily find "#12345 #6789"# You would like to be able to click on that id to open a custom web interface that gives details on that id# And we want to do it after markdown processingdefpost_custom_generate_url_by_id(self):ids=re.findall(r"#(\d+)",self.content)url_base='https://www.corporate.com/mytool/details?id={id}'foridinset(ids):url=url_base.format(id=id)self.content=re.sub(f'#{id}',f"[#{id}]({url})",self.content            )

Enable the plugin

{"tygenie": {"plugins": {"alerts_list_formatter":"Bob","alert_description_formatter":"Bob"    }  }}

Opsgenie API / OpenAPI / python-client

Related links

License